mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
classref: Sync with current master branch (655e93d)
This commit is contained in:
Godot Organization
299
classes/class_graphframe.rst
Normal file
299
classes/class_graphframe.rst
Normal file
@@ -0,0 +1,299 @@
|
||||
:github_url: hide
|
||||
|
||||
.. DO NOT EDIT THIS FILE!!!
|
||||
.. Generated automatically from Godot engine sources.
|
||||
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
||||
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphFrame.xml.
|
||||
|
||||
.. _class_GraphFrame:
|
||||
|
||||
GraphFrame
|
||||
==========
|
||||
|
||||
**Experimental:** This class may be changed or removed in future versions.
|
||||
|
||||
**Inherits:** :ref:`GraphElement<class_GraphElement>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
GraphFrame is a special :ref:`GraphElement<class_GraphElement>` that can be used to organize other :ref:`GraphElement<class_GraphElement>`\ s inside a :ref:`GraphEdit<class_GraphEdit>`.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
GraphFrame is a special :ref:`GraphElement<class_GraphElement>` to which other :ref:`GraphElement<class_GraphElement>`\ s can be attached. It can be configured to automatically resize to enclose all attached :ref:`GraphElement<class_GraphElement>`\ s. If the frame is moved, all the attached :ref:`GraphElement<class_GraphElement>`\ s inside it will be moved as well.
|
||||
|
||||
A GraphFrame is always kept behind the connection layer and other :ref:`GraphElement<class_GraphElement>`\ s inside a :ref:`GraphEdit<class_GraphEdit>`.
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`autoshrink_enabled<class_GraphFrame_property_autoshrink_enabled>` | ``true`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`autoshrink_margin<class_GraphFrame_property_autoshrink_margin>` | ``40`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`drag_margin<class_GraphFrame_property_drag_margin>` | ``16`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``0`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`tint_color<class_GraphFrame_property_tint_color>` | ``Color(0.3, 0.3, 0.3, 0.75)`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`tint_color_enabled<class_GraphFrame_property_tint_color_enabled>` | ``false`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
| :ref:`String<class_String>` | :ref:`title<class_GraphFrame_property_title>` | ``""`` |
|
||||
+----------------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`HBoxContainer<class_HBoxContainer>` | :ref:`get_titlebar_hbox<class_GraphFrame_method_get_titlebar_hbox>`\ (\ ) |
|
||||
+-------------------------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`resizer_color<class_GraphFrame_theme_color_resizer_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`panel<class_GraphFrame_theme_style_panel>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`panel_selected<class_GraphFrame_theme_style_panel_selected>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`titlebar<class_GraphFrame_theme_style_titlebar>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`titlebar_selected<class_GraphFrame_theme_style_titlebar_selected>` | |
|
||||
+---------------------------------+--------------------------------------------------------------------------+-----------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_GraphFrame_signal_autoshrink_changed:
|
||||
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**autoshrink_changed**\ (\ )
|
||||
|
||||
Emitted when :ref:`autoshrink_enabled<class_GraphFrame_property_autoshrink_enabled>` or :ref:`autoshrink_margin<class_GraphFrame_property_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<class_bool>` **autoshrink_enabled** = ``true``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_autoshrink_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_autoshrink_enabled**\ (\ )
|
||||
|
||||
If ``true``, the frame's rect will be adjusted automatically to enclose all attached :ref:`GraphElement<class_GraphElement>`\ s.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_GraphFrame_property_autoshrink_margin:
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **autoshrink_margin** = ``40``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_autoshrink_margin**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_autoshrink_margin**\ (\ )
|
||||
|
||||
The margin around the attached nodes that is used to calculate the size of the frame when :ref:`autoshrink_enabled<class_GraphFrame_property_autoshrink_enabled>` is ``true``.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_GraphFrame_property_drag_margin:
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **drag_margin** = ``16``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_drag_margin**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_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<class_Color>` **tint_color** = ``Color(0.3, 0.3, 0.3, 0.75)``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_tint_color**\ (\ value\: :ref:`Color<class_Color>`\ )
|
||||
- :ref:`Color<class_Color>` **get_tint_color**\ (\ )
|
||||
|
||||
The color of the frame when :ref:`tint_color_enabled<class_GraphFrame_property_tint_color_enabled>` is ``true``.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_GraphFrame_property_tint_color_enabled:
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **tint_color_enabled** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_tint_color_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_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<class_String>` **title** = ``""``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- |void| **set_title**\ (\ value\: :ref:`String<class_String>`\ )
|
||||
- :ref:`String<class_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<class_HBoxContainer>` **get_titlebar_hbox**\ (\ )
|
||||
|
||||
Returns the :ref:`HBoxContainer<class_HBoxContainer>` used for the title bar, only containing a :ref:`Label<class_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<class_Color>` **resizer_color** = ``Color(0.875, 0.875, 0.875, 1)``
|
||||
|
||||
The color modulation applied to the resizer icon.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_GraphFrame_theme_style_panel:
|
||||
|
||||
.. rst-class:: classref-themeproperty
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` **panel**
|
||||
|
||||
The default :ref:`StyleBox<class_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<class_StyleBox>` **panel_selected**
|
||||
|
||||
The :ref:`StyleBox<class_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<class_StyleBox>` **titlebar**
|
||||
|
||||
The :ref:`StyleBox<class_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<class_StyleBox>` **titlebar_selected**
|
||||
|
||||
The :ref:`StyleBox<class_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.)`
|
||||
Reference in New Issue
Block a user