pandora.margins.descriptors
===========================

.. py:module:: pandora.margins.descriptors

.. autoapi-nested-parse::

   This module contains descriptors which returns Margins.

   Descriptors are a kind of properties object that can be reused in several classes.
   They meant to be used as class attributes.



Classes
-------

.. autoapisummary::

   pandora.margins.descriptors.ReadOnlyDescriptor
   pandora.margins.descriptors.FixedMargins
   pandora.margins.descriptors.UniformMargins
   pandora.margins.descriptors.NullMargins
   pandora.margins.descriptors.HalfWindowMargins


Module Contents
---------------

.. py:class:: ReadOnlyDescriptor

   Descriptor that can not be reassigned.


   .. py:method:: __set_name__(owner: type[object], name: str) -> None


   .. py:method:: __set__(instance: object, value: object) -> None


.. py:class:: FixedMargins(left: int, up: int, right: int, down: int)

   Bases: :py:obj:`ReadOnlyDescriptor`


   Getter returns Margins with fixed values.


   .. py:attribute:: value


   .. py:method:: __get__(instance: None, owner: None) -> FixedMargins
                  __get__(instance: object, owner: type[object]) -> pandora.margins.Margins


.. py:class:: UniformMargins(value: int)

   Bases: :py:obj:`FixedMargins`


   Getter returns Margins with same fixed values in all directions.


.. py:class:: NullMargins

   Bases: :py:obj:`UniformMargins`


   Margins with null values in all directions.


.. py:class:: HalfWindowMargins

   Bases: :py:obj:`ReadOnlyDescriptor`


   Getter returns Margins corresponding to half window.

   Expects instance object has a `_window_size` member.


   .. py:method:: __get__(instance: None, owner: None) -> HalfWindowMargins
                  __get__(instance: object, owner: type[object]) -> pandora.margins.Margins