:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/GraphFrame.xml. .. _class_GraphFrame: GraphFrame ========== **Experimental:** This class may be changed or removed in future versions. **Inherits:** :ref:`GraphElement` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` GraphFrame is a special :ref:`GraphElement` that can be used to organize other :ref:`GraphElement`\ s inside a :ref:`GraphEdit`. .. rst-class:: classref-introduction-group Description ----------- GraphFrame is a special :ref:`GraphElement` to which other :ref:`GraphElement`\ s can be attached. It can be configured to automatically resize to enclose all attached :ref:`GraphElement`\ s. If the frame is moved, all the attached :ref:`GraphElement`\ s inside it will be moved as well. A GraphFrame is always kept behind the connection layer and other :ref:`GraphElement`\ s inside a :ref:`GraphEdit`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`bool` | :ref:`autoshrink_enabled` | ``true`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`int` | :ref:`autoshrink_margin` | ``40`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`int` | :ref:`drag_margin` | ``16`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`Color` | :ref:`tint_color` | ``Color(0.3, 0.3, 0.3, 0.75)`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`bool` | :ref:`tint_color_enabled` | ``false`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`String` | :ref:`title` | ``""`` | +----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+---------------------------------------------------------------------------+ | :ref:`HBoxContainer` | :ref:`get_titlebar_hbox`\ (\ ) | +-------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`resizer_color` | ``Color(0.875, 0.875, 0.875, 1)`` | +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel_selected` | | +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar` | | +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar_selected` | | +---------------------------------+--------------------------------------------------------------------------+-----------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_GraphFrame_signal_autoshrink_changed: .. rst-class:: classref-signal **autoshrink_changed**\ (\ ) :ref:`🔗` Emitted when :ref:`autoshrink_enabled` or :ref:`autoshrink_margin` changes. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GraphFrame_property_autoshrink_enabled: .. rst-class:: classref-property :ref:`bool` **autoshrink_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_autoshrink_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_autoshrink_enabled**\ (\ ) If ``true``, the frame's rect will be adjusted automatically to enclose all attached :ref:`GraphElement`\ s. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_property_autoshrink_margin: .. rst-class:: classref-property :ref:`int` **autoshrink_margin** = ``40`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_autoshrink_margin**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_autoshrink_margin**\ (\ ) The margin around the attached nodes that is used to calculate the size of the frame when :ref:`autoshrink_enabled` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_property_drag_margin: .. rst-class:: classref-property :ref:`int` **drag_margin** = ``16`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_drag_margin**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_drag_margin**\ (\ ) The margin inside the frame that can be used to drag the frame. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_property_tint_color: .. rst-class:: classref-property :ref:`Color` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tint_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_tint_color**\ (\ ) The color of the frame when :ref:`tint_color_enabled` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_property_tint_color_enabled: .. rst-class:: classref-property :ref:`bool` **tint_color_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tint_color_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_tint_color_enabled**\ (\ ) If ``true``, the tint color will be used to tint the frame. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_property_title: .. rst-class:: classref-property :ref:`String` **title** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_title**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_title**\ (\ ) Title of the frame. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GraphFrame_method_get_titlebar_hbox: .. rst-class:: classref-method :ref:`HBoxContainer` **get_titlebar_hbox**\ (\ ) :ref:`🔗` Returns the :ref:`HBoxContainer` used for the title bar, only containing a :ref:`Label` for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_GraphFrame_theme_color_resizer_color: .. rst-class:: classref-themeproperty :ref:`Color` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` The color modulation applied to the resizer icon. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_theme_style_panel: .. rst-class:: classref-themeproperty :ref:`StyleBox` **panel** :ref:`🔗` The default :ref:`StyleBox` used for the background of the **GraphFrame**. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_theme_style_panel_selected: .. rst-class:: classref-themeproperty :ref:`StyleBox` **panel_selected** :ref:`🔗` The :ref:`StyleBox` used for the background of the **GraphFrame** when it is selected. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_theme_style_titlebar: .. rst-class:: classref-themeproperty :ref:`StyleBox` **titlebar** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphFrame**. .. rst-class:: classref-item-separator ---- .. _class_GraphFrame_theme_style_titlebar_selected: .. rst-class:: classref-themeproperty :ref:`StyleBox` **titlebar_selected** :ref:`🔗` The :ref:`StyleBox` used for the title bar of the **GraphFrame** when it is selected. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`