Metadata-Version: 2.1
Name: odoo-addon-base_conditional_image
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: This module extends the functionality to support conditional images
Home-page: https://github.com/OCA/server-tools
License: AGPL-3
Author: Camptocamp, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==================
Conditional Images
==================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:a43e69abc9d533d059e3ba3612b938ea0ac06b4e7b766dd472382b3e631b7138
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
    :target: https://github.com/OCA/server-tools/tree/18.0/base_conditional_image
    :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-base_conditional_image
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of any model to support
conditional images (based on the record attributes) and to manage them
either globally or by company.

The main goal behind this module is to avoid storing the same image
multiple times. For example, for every partner, there is a related image
(most of the time, it's the default one). With this module properly set
up, it will be stored only one time and you can change it whenever you
want for all partners.

**WARNING**: this module cannot be used on the same objects using the
module base_multi_image.

**Table of contents**

.. contents::
   :local:

Installation
============

The sole purpose of this module is to add an abstract model to be
inherited. So, you will not notice any changes on install.

To develop using this module, you have to inherit the abstract model
conditional.image.consumer.mixin to the model that needs the conditional
images:

::

   class ResPartner(models.Model):
       _inherit = ['res.partner', 'conditional.image.consumer.mixin']
       _name = 'res.partner'

Then, configure how the images will be selected for each record.

Usage
=====

Go to *Technical Settings > Settings > Images* to configure all the
images. You can define images for specific objects, depending on the
attributes and the company of the object.

The selector should return a boolean expression. All fields of the
object are available to compute the result.

The system will first try to match an image with a company set up, then
with the ones without a company. If your object does not have a
company_id field, this check will be ignored and only images without a
company will be used.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_conditional_image%0Aversion:%2018.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.

Credits
=======

Authors
-------

* Camptocamp

Contributors
------------

- `Camptocamp <https://camptocamp.com/>`__:

  - Patrick Tombez <patrick.tombez@camptocamp.com>
  - Denis Leemann <denis.leemann@camptocamp.com>

- `Trobz <https://trobz.com>`__:

  - Son Ho <sonhd@trobz.com>

- `Heliconia Solutions Pvt. Ltd. <https://www.heliconia.io>`__

  - Bhavesh Heliconia

Other credits
-------------

The migration of this module from 12.0 to 14.0 was financially supported
by Camptocamp

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.0/base_conditional_image>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
