class_editorproperty.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the EditorProperty.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_EditorProperty:
  5. EditorProperty
  6. ==============
  7. **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +-----------------------------+--------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`checkable<class_EditorProperty_checkable>` |
  15. +-----------------------------+--------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`checked<class_EditorProperty_checked>` |
  17. +-----------------------------+--------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`draw_red<class_EditorProperty_draw_red>` |
  19. +-----------------------------+--------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`keying<class_EditorProperty_keying>` |
  21. +-----------------------------+--------------------------------------------------+
  22. | :ref:`String<class_String>` | :ref:`label<class_EditorProperty_label>` |
  23. +-----------------------------+--------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`read_only<class_EditorProperty_read_only>` |
  25. +-----------------------------+--------------------------------------------------+
  26. Methods
  27. -------
  28. +------------------------------+----------------------------------------------------------------------------------+
  29. | :ref:`Object<class_Object>` | :ref:`get_edited_object<class_EditorProperty_get_edited_object>` **(** **)** |
  30. +------------------------------+----------------------------------------------------------------------------------+
  31. | :ref:`String<class_String>` | :ref:`get_edited_property<class_EditorProperty_get_edited_property>` **(** **)** |
  32. +------------------------------+----------------------------------------------------------------------------------+
  33. | :ref:`String<class_String>` | :ref:`get_tooltip_text<class_EditorProperty_get_tooltip_text>` **(** **)** const |
  34. +------------------------------+----------------------------------------------------------------------------------+
  35. | void | :ref:`update_property<class_EditorProperty_update_property>` **(** **)** virtual |
  36. +------------------------------+----------------------------------------------------------------------------------+
  37. Signals
  38. -------
  39. .. _class_EditorProperty_multiple_properties_changed:
  40. - **multiple_properties_changed** **(** :ref:`PoolStringArray<class_PoolStringArray>` properties, :ref:`Array<class_Array>` value **)**
  41. .. _class_EditorProperty_object_id_selected:
  42. - **object_id_selected** **(** :ref:`String<class_String>` property, :ref:`int<class_int>` id **)**
  43. .. _class_EditorProperty_property_changed:
  44. - **property_changed** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**
  45. .. _class_EditorProperty_property_checked:
  46. - **property_checked** **(** :ref:`String<class_String>` property, :ref:`String<class_String>` bool **)**
  47. .. _class_EditorProperty_property_keyed:
  48. - **property_keyed** **(** :ref:`String<class_String>` property **)**
  49. .. _class_EditorProperty_property_keyed_with_value:
  50. - **property_keyed_with_value** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**
  51. .. _class_EditorProperty_resource_selected:
  52. - **resource_selected** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource **)**
  53. .. _class_EditorProperty_selected:
  54. - **selected** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` focusable_idx **)**
  55. Property Descriptions
  56. ---------------------
  57. .. _class_EditorProperty_checkable:
  58. - :ref:`bool<class_bool>` **checkable**
  59. +----------+----------------------+
  60. | *Setter* | set_checkable(value) |
  61. +----------+----------------------+
  62. | *Getter* | is_checkable() |
  63. +----------+----------------------+
  64. .. _class_EditorProperty_checked:
  65. - :ref:`bool<class_bool>` **checked**
  66. +----------+--------------------+
  67. | *Setter* | set_checked(value) |
  68. +----------+--------------------+
  69. | *Getter* | is_checked() |
  70. +----------+--------------------+
  71. .. _class_EditorProperty_draw_red:
  72. - :ref:`bool<class_bool>` **draw_red**
  73. +----------+---------------------+
  74. | *Setter* | set_draw_red(value) |
  75. +----------+---------------------+
  76. | *Getter* | is_draw_red() |
  77. +----------+---------------------+
  78. .. _class_EditorProperty_keying:
  79. - :ref:`bool<class_bool>` **keying**
  80. +----------+-------------------+
  81. | *Setter* | set_keying(value) |
  82. +----------+-------------------+
  83. | *Getter* | is_keying() |
  84. +----------+-------------------+
  85. .. _class_EditorProperty_label:
  86. - :ref:`String<class_String>` **label**
  87. +----------+------------------+
  88. | *Setter* | set_label(value) |
  89. +----------+------------------+
  90. | *Getter* | get_label() |
  91. +----------+------------------+
  92. .. _class_EditorProperty_read_only:
  93. - :ref:`bool<class_bool>` **read_only**
  94. +----------+----------------------+
  95. | *Setter* | set_read_only(value) |
  96. +----------+----------------------+
  97. | *Getter* | is_read_only() |
  98. +----------+----------------------+
  99. Method Descriptions
  100. -------------------
  101. .. _class_EditorProperty_get_edited_object:
  102. - :ref:`Object<class_Object>` **get_edited_object** **(** **)**
  103. .. _class_EditorProperty_get_edited_property:
  104. - :ref:`String<class_String>` **get_edited_property** **(** **)**
  105. .. _class_EditorProperty_get_tooltip_text:
  106. - :ref:`String<class_String>` **get_tooltip_text** **(** **)** const
  107. .. _class_EditorProperty_update_property:
  108. - void **update_property** **(** **)** virtual