[UPD] README.rst

This commit is contained in:
OCA-git-bot
2023-09-03 17:54:58 +00:00
parent c755914fa6
commit 80faf8d8af
115 changed files with 1974 additions and 1686 deletions

View File

@@ -2,10 +2,13 @@
Confirm/Alert pop-up before saving
==================================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7ffe943eb22ee465e35d6e7d5eeca244b46c04ac4b25c62a1afc5c214fa80ca9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
@@ -19,11 +22,11 @@ Confirm/Alert pop-up before saving
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_create_write_confirm
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/162/14.0
:alt: Try me on Runbot
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=14.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
|badge1| |badge2| |badge3| |badge4| |badge5|
This module provides feature to create custom confirmation or alert dialog when user creates or writes record.
Module includes only methods that you can use in your code. That means programming is always required.
@@ -77,7 +80,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_create_write_confirm%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.

View File

@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="utf-8" ?>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>Confirm/Alert pop-up before saving</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
@@ -366,75 +366,77 @@ ul.auto-toc {
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:7ffe943eb22ee465e35d6e7d5eeca244b46c04ac4b25c62a1afc5c214fa80ca9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/14.0/web_create_write_confirm"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_create_write_confirm"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/web/tree/14.0/web_create_write_confirm"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-14-0/web-14-0-web_create_write_confirm"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&amp;target_branch=14.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module provides feature to create custom confirmation or alert dialog when user creates or writes record.
Module includes only methods that you can use in your code. That means programming is always required.
See usage section for more information.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<p>Create popup.message record. Specify model_id, field_ids (which fields will trigger alert) and other fields.
Put you code into <strong>get_message_informations</strong> or <strong>execute_processing</strong> method of you model.
Return dict (perform read() to get it).
Here is some examples how you can use this module features in your code.</p>
<p>Confirm res.partner change:</p>
<pre class="code python literal-block">
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'popup.message'</span><span class="p">]</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
<span class="p">{</span>
<span class="s1">'model_id'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'res.partner'</span><span class="p">)])</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="s1">'field_ids'</span><span class="p">:</span> <span class="p">[(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model.fields'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'res.partner'</span><span class="p">)])</span><span class="o">.</span><span class="n">ids</span><span class="p">)],</span>
<span class="s1">'popup_type'</span><span class="p">:</span> <span class="s1">'confirm'</span><span class="p">,</span>
<span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Warning'</span><span class="p">,</span>
<span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Are you sure want to update record?'</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'popup.message'</span><span class="p">]</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="w">
</span> <span class="p">{</span><span class="w">
</span> <span class="s1">'model_id'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'res.partner'</span><span class="p">)])</span><span class="o">.</span><span class="n">id</span><span class="p">,</span><span class="w">
</span> <span class="s1">'field_ids'</span><span class="p">:</span> <span class="p">[(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model.fields'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'res.partner'</span><span class="p">)])</span><span class="o">.</span><span class="n">ids</span><span class="p">)],</span><span class="w">
</span> <span class="s1">'popup_type'</span><span class="p">:</span> <span class="s1">'confirm'</span><span class="p">,</span><span class="w">
</span> <span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Warning'</span><span class="p">,</span><span class="w">
</span> <span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Are you sure want to update record?'</span><span class="p">,</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span><span class="p">)</span><span class="w">
</span><span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</pre>
<p>Sale order alert:</p>
<pre class="code python literal-block">
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'popup.message'</span><span class="p">]</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
<span class="p">{</span>
<span class="s1">'model_id'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'sale.order'</span><span class="p">)])</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="s1">'field_ids'</span><span class="p">:</span> <span class="p">[(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model.fields'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'sale.order'</span><span class="p">)])</span><span class="o">.</span><span class="n">ids</span><span class="p">)],</span>
<span class="s1">'popup_type'</span><span class="p">:</span> <span class="s1">'alert'</span><span class="p">,</span>
<span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Attention'</span><span class="p">,</span>
<span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Sale order was updated.'</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'popup.message'</span><span class="p">]</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="w">
</span> <span class="p">{</span><span class="w">
</span> <span class="s1">'model_id'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'sale.order'</span><span class="p">)])</span><span class="o">.</span><span class="n">id</span><span class="p">,</span><span class="w">
</span> <span class="s1">'field_ids'</span><span class="p">:</span> <span class="p">[(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">[</span><span class="s1">'ir.model.fields'</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">([(</span><span class="s1">'model'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'sale.order'</span><span class="p">)])</span><span class="o">.</span><span class="n">ids</span><span class="p">)],</span><span class="w">
</span> <span class="s1">'popup_type'</span><span class="p">:</span> <span class="s1">'alert'</span><span class="p">,</span><span class="w">
</span> <span class="s1">'title'</span><span class="p">:</span> <span class="s1">'Attention'</span><span class="p">,</span><span class="w">
</span> <span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Sale order was updated.'</span><span class="p">,</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span><span class="p">)</span><span class="w">
</span><span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
</pre>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_create_write_confirm%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<ul class="simple">
<li>Smile</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://www.smile.eu/en">Smile</a></li>
<li><a class="reference external" href="https://www.ooops404.com">Ooops404</a>:<ul>
@@ -444,7 +446,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose