You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

173 lines
6.3 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ==================================
  5. Add new options for many2one field
  6. ==================================
  7. Description
  8. -----------
  9. This modules modifies "many2one" and "many2manytags" form widgets so as to add some new display
  10. control options.
  11. Options provided includes possibility to remove "Create..." and/or "Create and
  12. Edit..." entries from many2one drop down. You can also change default number of
  13. proposition appearing in the drop-down. Or prevent the dialog box poping in
  14. case of validation error.
  15. If not specified, the module will avoid proposing any of the create options
  16. if the current user has no permission rights to create the related object.
  17. Usage
  18. =====
  19. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  20. :alt: Try me on Runbot
  21. :target: https://runbot.odoo-community.org/runbot/162/8.0
  22. For further information, please visit:
  23. * https://www.odoo.com/forum/help-1
  24. in the field's options dict
  25. ---------------------------
  26. ``create`` *boolean* (Default: depends if user have create rights)
  27. Whether to display the "Create..." entry in dropdown panel.
  28. ``create_edit`` *boolean* (Default: depends if user have create rights)
  29. Whether to display "Create and Edit..." entry in dropdown panel
  30. ``m2o_dialog`` *boolean* (Default: depends if user have create rights)
  31. Whether to display the many2one dialog in case of validation error.
  32. ``limit`` *int* (Default: openerp default value is ``7``)
  33. Number of displayed record in drop-down panel
  34. ``search_more`` *boolean*
  35. Used to force disable/enable search more button.
  36. ``field_color`` *string*
  37. A string to define the field used to define color.
  38. This option has to be used with colors.
  39. ``colors`` *dictionary*
  40. A dictionary to link field value with a HTML color.
  41. This option has to be used with field_color.
  42. ``no_open_edit`` *boolean* (Default: value of ``no_open`` which is ``False`` if not set)
  43. Causes a many2one not to offer to click through in edit mode, but well in read mode
  44. ``open`` *boolean* (Default: ``False``)
  45. Makes many2many_tags buttons that open the linked resource
  46. ``no_color_picker`` *boolean* (Default: ``False``)
  47. Deactivates the color picker on many2many_tags buttons to do nothing (ignored if open is set)
  48. ir.config_parameter options
  49. ---------------------------
  50. Now you can disable "Create..." and "Create and Edit..." entry for all widgets in the odoo instance.
  51. If you disable one option, you can enable it for particular field by setting "create: True" option directly on the field definition.
  52. ``web_m2x_options.create`` *boolean* (Default: depends if user have create rights)
  53. Whether to display the "Create..." entry in dropdown panel for all fields in the odoo instance.
  54. ``web_m2x_options.create_edit`` *boolean* (Default: depends if user have create rights)
  55. Whether to display "Create and Edit..." entry in dropdown panel for all fields in the odoo instance.
  56. ``web_m2x_options.m2o_dialog`` *boolean* (Default: depends if user have create rights)
  57. Whether to display the many2one dialog in case of validation error for all fields in the odoo instance.
  58. ``web_m2x_options.limit`` *int* (Default: openerp default value is ``7``)
  59. Number of displayed record in drop-down panel for all fields in the odoo instance
  60. ``web_m2x_options.search_more`` *boolean* (Default: default value is ``False``)
  61. Whether the field should always show "Search more..." entry or not.
  62. To add these parameters go to Configuration -> Technical -> Parameters -> System Parameters and add new parameters like:
  63. - web_m2x_options.create: False
  64. - web_m2x_options.create_edit: False
  65. - web_m2x_options.m2o_dialog: False
  66. - web_m2x_options.limit: 10
  67. - web_m2x_options.search_more: True
  68. Example
  69. -------
  70. Your XML form view definition could contain::
  71. ...
  72. <field name="partner_id" options="{'limit': 10, 'create': false, 'create_edit': false, 'search_more':true 'field_color':'state', 'colors':{'active':'green'}}"/>
  73. ...
  74. Known issues
  75. ============
  76. Double check that you have no inherited view that remove ``options`` you set on a field !
  77. If nothing works, add a debugger in the first line of ``get_search_result method`` and enable debug mode in Odoo. When you write something in a many2one field, javascript debugger should pause. If not verify your installation.
  78. ``create_edit`` and ``create`` are now supported by default in Odoo's core (``no_create_edit``, ``no_create``). So, these keywords should be removed when migrating to 11.0 (we keep them in version 10.0 to preserve the compatibility with the previous 10.0 versions of this module)
  79. Roadmap
  80. =======
  81. - Instead of making the tags rectangle clickable, I think it's better to put the text as a clickable link, so we will get a consistent behaviour/aspect with other clickable elements (many2one...).
  82. - In edit mode, it would be great to add an icon like the one on many2one fields to allow to open the many2many in a popup window.
  83. - Include this feature as a configurable option via parameter to have this behaviour by default in all many2many tags.
  84. Bug Tracker
  85. ===========
  86. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  87. In case of trouble, please check there if your issue has already been reported.
  88. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  89. `here <https://github.com/OCA/web/issues/new?body=module:%20web_m2x_options%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  90. Credits
  91. =======
  92. Contributors
  93. ------------
  94. * David Coninckx <davconinckx@gmail.com>
  95. * Emanuel Cino <ecino@compassion.ch>
  96. * Holger Brunn <hbrunn@therp.nl>
  97. * Nicolas JEUDY <nicolas@sudokeys.com>
  98. * Yannick Vaucher <yannick.vaucher@camptocamp.com>
  99. * Zakaria Makrelouf <z.makrelouf@gmail.com>
  100. * Jairo Llopis <jairo.llopis@tecnativa.com>
  101. * David Vidal <david.vidal@tecnativa.com>
  102. Maintainer
  103. ----------
  104. .. image:: https://odoo-community.org/logo.png
  105. :alt: Odoo Community Association
  106. :target: https://odoo-community.org
  107. This module is maintained by the OCA.
  108. OCA, or the Odoo Community Association, is a nonprofit organization whose
  109. mission is to support the collaborative development of Odoo features and
  110. promote its widespread use.
  111. To contribute to this module, please visit http://odoo-community.org.