tik_manager4.ui.widgets.common
==============================

.. py:module:: tik_manager4.ui.widgets.common

.. autoapi-nested-parse::

   Common usage basic widgets.



Attributes
----------

.. autoapisummary::

   tik_manager4.ui.widgets.common.BUTTON_STYLE
   tik_manager4.ui.widgets.common.FONT


Classes
-------

.. autoapisummary::

   tik_manager4.ui.widgets.common.ClickableFrame
   tik_manager4.ui.widgets.common.HeaderLabel
   tik_manager4.ui.widgets.common.HorizontalSeparator
   tik_manager4.ui.widgets.common.ResolvedText
   tik_manager4.ui.widgets.common.StyleFrame
   tik_manager4.ui.widgets.common.TikButton
   tik_manager4.ui.widgets.common.TikButtonBox
   tik_manager4.ui.widgets.common.TikIconButton
   tik_manager4.ui.widgets.common.TikLabel
   tik_manager4.ui.widgets.common.TikLabelButton
   tik_manager4.ui.widgets.common.TikMessageBox
   tik_manager4.ui.widgets.common.VerticalSeparator


Functions
---------

.. autoapisummary::

   tik_manager4.ui.widgets.common.lighten_color


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

.. py:class:: ClickableFrame(*args, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QFrame`


   Clickable frame widget.


   .. py:method:: mousePressEvent(event)


   .. py:attribute:: clicked


.. py:class:: HeaderLabel(*args, **kwargs)

   Bases: :py:obj:`TikLabel`


   Label with bold font and indent.


   .. py:method:: set_font_size(font_size, bold=True)


   .. py:attribute:: style_sheet
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
         QLabel
         {
             background-color: #404040;
             border-width: 1px;
             border-color: #1e1e1e;
             border-style: solid;
             padding: 5px;
             font-size: 12x;
             border-radius: 14px;
         }
         """

      .. raw:: html

         </details>




.. py:class:: HorizontalSeparator(color=(100, 100, 100), height=1, width=None)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QLabel`


   Simple horizontal separator.


   .. py:method:: set_color(color)


.. py:class:: ResolvedText(*args, **kwargs)

   Bases: :py:obj:`TikLabel`


   Label for resolved paths, names etc.


   .. py:method:: set_font_size(font_size, bold=True)


.. py:class:: StyleFrame(*args, **kwargs)

   Bases: :py:obj:`ClickableFrame`


   Frame with custom styling support.


   .. py:method:: set_style(stylesheet)

      Set the stylesheet for this frame.



.. py:class:: TikButton(text='', font_size=10, text_color=None, border_color=None, background_color=None, parent=None, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QPushButton`


   Unified button class for the whole app.


   .. py:method:: set_color(text_color=None, background_color=None, border_color=None)

      Set the button colors.

      Args:
          text_color: Color for text (hex string or RGB tuple/list)
          background_color: Color for background (hex string or RGB tuple/list)
          border_color: Color for border (hex string or RGB tuple/list)



   .. py:method:: set_font_size(font_size)


   .. py:attribute:: DEFAULT_BACKGROUND_COLOR
      :value: '#404040'



   .. py:attribute:: DEFAULT_BORDER_COLOR
      :value: '#1e1e1e'



   .. py:attribute:: DEFAULT_TEXT_COLOR
      :value: '#b1b1b1'



.. py:class:: TikButtonBox(*args, font_size=10, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QDialogButtonBox`


   Unified button box class for the whole app.


   .. py:method:: event(event)


   .. py:method:: modifyButton(button)


   .. py:method:: set_font_size(font_size)


.. py:class:: TikIconButton(icon_name=None, circle=True, size=22, icon_size=None, *args, **kwargs)

   Bases: :py:obj:`TikButton`


   Button specific for fixed sized icons.


   .. py:method:: set_icon(icon_name)


   .. py:method:: set_size(size)


   .. py:method:: square_to_circle_multiplier(side_length)
      :staticmethod:



.. py:class:: TikLabel(text='', font_size=10, bold=False, color=(255, 255, 255), parent=None, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QLabel`


   Unified label class for the whole app.


   .. py:method:: set_color(text_color=None, background_color=None, border_color=None)

      Set the label colors.

      Args:
          text_color: Color for text (hex string or RGB tuple/list)
          background_color: Unused, kept for API compatibility
          border_color: Color for border (hex string or RGB tuple/list)



   .. py:method:: set_font_size(font_size, bold=False)


   .. py:method:: set_text(text)


   .. py:attribute:: DEFAULT_BORDER_COLOR
      :value: '#1e1e1e'



   .. py:attribute:: DEFAULT_TEXT_COLOR
      :value: '#b1b1b1'



.. py:class:: TikLabelButton(*args, color=(255, 255, 255), **kwargs)

   Bases: :py:obj:`TikButton`


   Customize the button to be used next to the header.


   .. py:method:: set_state_text(checked)


   .. py:attribute:: style_sheet
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
             QPushButton
             {{
                 color: {0};
                 background-color: #404040;
                 border-width: 1px;
                 border-color: {0};
                 border-style: solid;
                 padding: 5px;
                 font-size: 12x;
                 border-radius: 0px;
             }}"""

      .. raw:: html

         </details>




.. py:class:: TikMessageBox(*args, font_size=10, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QMessageBox`


   Message box with custom font.


   .. py:method:: set_font_size(font_size)


.. py:class:: VerticalSeparator(color=(100, 100, 100), height=25, width=20)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QLabel`


   Simple vertical separator.


   .. py:method:: set_color(color)


.. py:function:: lighten_color(color_str, factor=110)

   Lightens the given color.

   Args:
       color_str (str): The color to lighten as a hex string.
       factor (int): The percentage to lighten (100 = no change, >100 = lighter, <100 = darker).

   Returns:
       str: A lighter color as a hex string.


.. py:data:: BUTTON_STYLE
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      QPushButton
      {
          color: #b1b1b1;
          background-color: #404040;
          border-width: 1px;
          border-color: #1e1e1e;
          border-style: solid;
          padding: 5px;
          font-size: 12x;
          border-radius: 4px;
      }
      
      QPushButton:hover
      {
          background-color: #505050;
          border: 1px solid #ff8d1c;
      }
      
      QPushButton:hover[circle=true]
      {
          background-color: #505050;
          border: 2px solid #ff8d1c;
      }
      
      QPushButton:disabled {
          color: #505050;
          background-color: #303030;
          border: 1px solid #404040;
          border-width: 1px;
          border-color: #1e1e1e;
          border-style: solid;
          padding: 5px;
          font-size: 12x;
      }
      
      QPushButton:pressed {
        background-color: #ff8d1c;
        border: 1px solid #ff8d1c;
      }
      """

   .. raw:: html

      </details>



.. py:data:: FONT
   :value: 'Arial'