======
Button
======

.. py:currentmodule:: p3dsdk

.. py:class:: Button


   .. py:method:: id
      :property:

      The id of the button.

      :type: str, read-only

   .. py:method:: visible
      :property:

      The visible state of the button.

      :type: bool

   .. py:method:: name
      :property:

      The name of the button.

      :type: str, read-only

   .. py:method:: shortcut
      :property:

      The shortcut assigned to the button.

      :type: str



CustomButton
------------

.. py:class:: CustomButton

   Base class: :py:class:`Button`


   .. py:method:: id
      :property:

      The id of the button.

      :type: str, read-only

   .. py:method:: visible
      :property:

      The visible state of the button.

      :type: bool

   .. py:method:: name
      :property:

      The name of the button.

      :type: str, read-only

   .. py:method:: shortcut
      :property:

      The shortcut assigned to the button.

      :type: str

   .. py:method:: script
      :property:

      The script path of the button.

      :type: str

   .. py:method:: icon
      :property:

      The icon file path of the button.

      :type: str

   .. py:method:: label
      :property:

      The label of the button.

      :type: str

   .. py:method:: description
      :property:

      The description of the button.

      :type: str

   .. py:method:: enabled
      :property:

      Whether the button is enabled or not.

      :type: bool

   .. py:method:: toggled
      :property:

      Whether the button is toggled or not.

      :type: bool



CycleButton
-----------

.. py:class:: CycleButton

   Base class: :py:class:`Button`


   .. py:method:: id
      :property:

      The id of the button.

      :type: str, read-only

   .. py:method:: visible
      :property:

      The visible state of the button.

      :type: bool

   .. py:method:: name
      :property:

      The name of the button.

      :type: str, read-only

   .. py:method:: shortcut
      :property:

      The shortcut assigned to the button.

      :type: str


   .. py:method:: insert_action(name)

      Insert action from name in the cycle button.

      :param name: The name of the action inserted.
      :type name: str



   .. py:method:: create_custom_action(name)

      Create custom action from name in the popup

      .. note::
         The action's name must be unique in the whole application.

      :param name: The name of the the new custom action created.
      :type name: str

      :returns: The new custom action created.
      :rtype: CustomAction



PopupButton
-----------

.. py:class:: PopupButton

   Base class: :py:class:`Button`


   .. py:method:: id
      :property:

      The id of the button.

      :type: str, read-only

   .. py:method:: visible
      :property:

      The visible state of the button.

      :type: bool

   .. py:method:: name
      :property:

      The name of the button.

      :type: str, read-only

   .. py:method:: shortcut
      :property:

      The shortcut assigned to the button.

      :type: str


   .. py:method:: insert_action(name)

      Insert action from name in the popup.

      :param name: The name of the action inserted.
      :type name: str



   .. py:method:: create_custom_action(name)

      Create custom action from name in the popup

      .. note::
         The action's name must be unique in the whole application.

      :param name: The name of the the new custom action created.
      :type name: str

      :returns: The new custom action created.
      :rtype: CustomAction



TinyPopupButton
---------------

.. py:class:: TinyPopupButton

   Base class: :py:class:`Button`


   .. py:method:: id
      :property:

      The id of the button.

      :type: str, read-only

   .. py:method:: visible
      :property:

      The visible state of the button.

      :type: bool

   .. py:method:: name
      :property:

      The name of the button.

      :type: str, read-only

   .. py:method:: shortcut
      :property:

      The shortcut assigned to the button.

      :type: str

   .. py:method:: icon
      :property:

      The icon file path of the button.

      :type: str

   .. py:method:: label
      :property:

      The label of the button.

      :type: str

   .. py:method:: description
      :property:

      The description of the button.

      :type: str


   .. py:method:: insert_action(name)

      Insert action from name in the popup.

      :param name: The name of the action inserted.
      :type name: str



   .. py:method:: create_custom_action(name)

      Create custom action from name in the popup

      .. note::
         The action's name must be unique in the whole application.

      :param name: The name of the new custom action created.
      :type name: str

      :returns: The new custom action created.
      :rtype: CustomAction