diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 0bef3bc22..2911ec422 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -21,7 +21,7 @@ By setting various properties on this object, you can control how individual cha Tutorials --------- -- :doc:`../tutorials/gui/bbcode_in_richtextlabel` +- :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project `__ diff --git a/classes/class_control.rst b/classes/class_control.rst index 564e6d11e..954f9188b 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -37,7 +37,7 @@ Sets :ref:`mouse_filter` to :ref:`MOUSE_FIL Tutorials --------- -- :doc:`../tutorials/gui/index` +- :doc:`../tutorials/ui/index` - :doc:`../tutorials/2d/custom_drawing_in_2d` diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index adbcd313a..c3c0d542a 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -30,7 +30,7 @@ A custom effect for use with :ref:`RichTextLabel`. Tutorials --------- -- :doc:`../tutorials/gui/bbcode_in_richtextlabel` +- :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project `__ diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 2aa39f374..d0a5e6fbc 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -31,7 +31,7 @@ Rich text can contain custom text, fonts, images and some basic formatting. The Tutorials --------- -- :doc:`../tutorials/gui/bbcode_in_richtextlabel` +- :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `GUI Rich Text/BBcode Demo `__ diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 496ab2862..046bd98e5 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -23,7 +23,7 @@ Theme resources can alternatively be loaded by writing them in a ``.theme`` file Tutorials --------- -- :doc:`../tutorials/gui/gui_skinning` +- :doc:`../tutorials/ui/gui_skinning` Properties ---------- diff --git a/index.rst b/index.rst index 8cc0f0de1..1446ac25c 100644 --- a/index.rst +++ b/index.rst @@ -95,7 +95,7 @@ The main documentation for the site is organized into the following sections: tutorials/inputs/index tutorials/io/index tutorials/i18n/index - tutorials/gui/index + tutorials/ui/index tutorials/rendering/index tutorials/shaders/index tutorials/networking/index diff --git a/tutorials/gui/index.rst b/tutorials/gui/index.rst deleted file mode 100644 index ba7615b9b..000000000 --- a/tutorials/gui/index.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. _doc_user_interface: - -User Interface (UI) -=================== - -In this section of the tutorial we explain the basics of creating a graphical -user interface (GUI) in Godot. - -UI building blocks ------------------- - -Like everything else in Godot the user interface is built using nodes, specifically -:ref:`Control ` nodes. There are many different types of controls -which are useful for creating specific types of the GUI. For simplicity we can -separate them into two groups: content and layout. - -Typical content controls include: - -* :ref:`Buttons ` -* :ref:`Labels ` -* :ref:`LineEdits ` and :ref:`TextEdits ` - -Typical layout controls include: - -* :ref:`BoxContainers ` -* :ref:`MarginContainers ` -* :ref:`ScrollContainers ` -* :ref:`TabContainers ` -* :ref:`Popups ` - -The following pages explain the basics of using such controls. - -.. toctree:: - :maxdepth: 1 - :name: toc-gui-basics - - size_and_anchors - gui_containers - custom_gui_controls - gui_navigation - control_node_gallery - -GUI skinning and themes ------------------------ - -Godot features an in-depth skinning/theming system for control nodes. The pages in this section -explain the benefits of that system and how to set it up in your projects. - -.. toctree:: - :maxdepth: 1 - :name: toc-gui-skinning - - gui_skinning - gui_using_theme_editor - -Control node tutorials ----------------------- - -The following articles cover specific details of using particular control nodes. - -.. toctree:: - :maxdepth: 1 - :name: toc-control-nodes-tutorials - - bbcode_in_richtextlabel diff --git a/tutorials/gui/bbcode_in_richtextlabel.rst b/tutorials/ui/bbcode_in_richtextlabel.rst similarity index 100% rename from tutorials/gui/bbcode_in_richtextlabel.rst rename to tutorials/ui/bbcode_in_richtextlabel.rst diff --git a/tutorials/gui/control_node_gallery.rst b/tutorials/ui/control_node_gallery.rst similarity index 100% rename from tutorials/gui/control_node_gallery.rst rename to tutorials/ui/control_node_gallery.rst diff --git a/tutorials/gui/custom_gui_controls.rst b/tutorials/ui/custom_gui_controls.rst similarity index 100% rename from tutorials/gui/custom_gui_controls.rst rename to tutorials/ui/custom_gui_controls.rst diff --git a/tutorials/ui/files/skin_assets.zip b/tutorials/ui/files/skin_assets.zip new file mode 100644 index 000000000..f84d9dbe4 Binary files /dev/null and b/tutorials/ui/files/skin_assets.zip differ diff --git a/tutorials/gui/gui_containers.rst b/tutorials/ui/gui_containers.rst similarity index 100% rename from tutorials/gui/gui_containers.rst rename to tutorials/ui/gui_containers.rst diff --git a/tutorials/gui/gui_navigation.rst b/tutorials/ui/gui_navigation.rst similarity index 100% rename from tutorials/gui/gui_navigation.rst rename to tutorials/ui/gui_navigation.rst diff --git a/tutorials/gui/gui_skinning.rst b/tutorials/ui/gui_skinning.rst similarity index 100% rename from tutorials/gui/gui_skinning.rst rename to tutorials/ui/gui_skinning.rst diff --git a/tutorials/gui/gui_using_theme_editor.rst b/tutorials/ui/gui_using_theme_editor.rst similarity index 100% rename from tutorials/gui/gui_using_theme_editor.rst rename to tutorials/ui/gui_using_theme_editor.rst diff --git a/tutorials/gui/img/add_item_type.png b/tutorials/ui/img/add_item_type.png similarity index 100% rename from tutorials/gui/img/add_item_type.png rename to tutorials/ui/img/add_item_type.png diff --git a/tutorials/gui/img/anchors.png b/tutorials/ui/img/anchors.png similarity index 100% rename from tutorials/gui/img/anchors.png rename to tutorials/ui/img/anchors.png diff --git a/tutorials/gui/img/bbcodeDemo.png b/tutorials/ui/img/bbcodeDemo.png similarity index 100% rename from tutorials/gui/img/bbcodeDemo.png rename to tutorials/ui/img/bbcodeDemo.png diff --git a/tutorials/gui/img/bbcodeText.png b/tutorials/ui/img/bbcodeText.png similarity index 100% rename from tutorials/gui/img/bbcodeText.png rename to tutorials/ui/img/bbcodeText.png diff --git a/tutorials/gui/img/container_example.gif b/tutorials/ui/img/container_example.gif similarity index 100% rename from tutorials/gui/img/container_example.gif rename to tutorials/ui/img/container_example.gif diff --git a/tutorials/gui/img/container_size_flags.png b/tutorials/ui/img/container_size_flags.png similarity index 100% rename from tutorials/gui/img/container_size_flags.png rename to tutorials/ui/img/container_size_flags.png diff --git a/tutorials/gui/img/containers_box.png b/tutorials/ui/img/containers_box.png similarity index 100% rename from tutorials/gui/img/containers_box.png rename to tutorials/ui/img/containers_box.png diff --git a/tutorials/gui/img/containers_center_pan.gif b/tutorials/ui/img/containers_center_pan.gif similarity index 100% rename from tutorials/gui/img/containers_center_pan.gif rename to tutorials/ui/img/containers_center_pan.gif diff --git a/tutorials/gui/img/containers_grid.png b/tutorials/ui/img/containers_grid.png similarity index 100% rename from tutorials/gui/img/containers_grid.png rename to tutorials/ui/img/containers_grid.png diff --git a/tutorials/gui/img/containers_margin.png b/tutorials/ui/img/containers_margin.png similarity index 100% rename from tutorials/gui/img/containers_margin.png rename to tutorials/ui/img/containers_margin.png diff --git a/tutorials/gui/img/containers_margin_constants.png b/tutorials/ui/img/containers_margin_constants.png similarity index 100% rename from tutorials/gui/img/containers_margin_constants.png rename to tutorials/ui/img/containers_margin_constants.png diff --git a/tutorials/gui/img/containers_panel.png b/tutorials/ui/img/containers_panel.png similarity index 100% rename from tutorials/gui/img/containers_panel.png rename to tutorials/ui/img/containers_panel.png diff --git a/tutorials/gui/img/containers_scroll.png b/tutorials/ui/img/containers_scroll.png similarity index 100% rename from tutorials/gui/img/containers_scroll.png rename to tutorials/ui/img/containers_scroll.png diff --git a/tutorials/gui/img/containers_split.png b/tutorials/ui/img/containers_split.png similarity index 100% rename from tutorials/gui/img/containers_split.png rename to tutorials/ui/img/containers_split.png diff --git a/tutorials/gui/img/containers_split_drag.gif b/tutorials/ui/img/containers_split_drag.gif similarity index 100% rename from tutorials/gui/img/containers_split_drag.gif rename to tutorials/ui/img/containers_split_drag.gif diff --git a/tutorials/gui/img/containers_tab.png b/tutorials/ui/img/containers_tab.png similarity index 100% rename from tutorials/gui/img/containers_tab.png rename to tutorials/ui/img/containers_tab.png diff --git a/tutorials/gui/img/containers_tab_click.gif b/tutorials/ui/img/containers_tab_click.gif similarity index 100% rename from tutorials/gui/img/containers_tab_click.gif rename to tutorials/ui/img/containers_tab_click.gif diff --git a/tutorials/gui/img/default_font.png b/tutorials/ui/img/default_font.png similarity index 100% rename from tutorials/gui/img/default_font.png rename to tutorials/ui/img/default_font.png diff --git a/tutorials/gui/img/default_preview.png b/tutorials/ui/img/default_preview.png similarity index 100% rename from tutorials/gui/img/default_preview.png rename to tutorials/ui/img/default_preview.png diff --git a/tutorials/gui/img/fade.png b/tutorials/ui/img/fade.png similarity index 100% rename from tutorials/gui/img/fade.png rename to tutorials/ui/img/fade.png diff --git a/tutorials/gui/img/focus_settings.png b/tutorials/ui/img/focus_settings.png similarity index 100% rename from tutorials/gui/img/focus_settings.png rename to tutorials/ui/img/focus_settings.png diff --git a/tutorials/gui/img/godot_containers.png b/tutorials/ui/img/godot_containers.png similarity index 100% rename from tutorials/gui/img/godot_containers.png rename to tutorials/ui/img/godot_containers.png diff --git a/tutorials/gui/img/import_items.png b/tutorials/ui/img/import_items.png similarity index 100% rename from tutorials/gui/img/import_items.png rename to tutorials/ui/img/import_items.png diff --git a/tutorials/gui/img/layout_dropdown_menu.png b/tutorials/ui/img/layout_dropdown_menu.png similarity index 100% rename from tutorials/gui/img/layout_dropdown_menu.png rename to tutorials/ui/img/layout_dropdown_menu.png diff --git a/tutorials/gui/img/manage_items.png b/tutorials/ui/img/manage_items.png similarity index 100% rename from tutorials/gui/img/manage_items.png rename to tutorials/ui/img/manage_items.png diff --git a/tutorials/gui/img/margin.png b/tutorials/ui/img/margin.png similarity index 100% rename from tutorials/gui/img/margin.png rename to tutorials/ui/img/margin.png diff --git a/tutorials/gui/img/marginaround.png b/tutorials/ui/img/marginaround.png similarity index 100% rename from tutorials/gui/img/marginaround.png rename to tutorials/ui/img/marginaround.png diff --git a/tutorials/gui/img/marginend.png b/tutorials/ui/img/marginend.png similarity index 100% rename from tutorials/gui/img/marginend.png rename to tutorials/ui/img/marginend.png diff --git a/tutorials/gui/img/new_theme.png b/tutorials/ui/img/new_theme.png similarity index 100% rename from tutorials/gui/img/new_theme.png rename to tutorials/ui/img/new_theme.png diff --git a/tutorials/gui/img/rainbow.png b/tutorials/ui/img/rainbow.png similarity index 100% rename from tutorials/gui/img/rainbow.png rename to tutorials/ui/img/rainbow.png diff --git a/tutorials/ui/img/sb1.png b/tutorials/ui/img/sb1.png new file mode 100644 index 000000000..4581e024d Binary files /dev/null and b/tutorials/ui/img/sb1.png differ diff --git a/tutorials/ui/img/sb2.png b/tutorials/ui/img/sb2.png new file mode 100644 index 000000000..7fe1746b2 Binary files /dev/null and b/tutorials/ui/img/sb2.png differ diff --git a/tutorials/gui/img/scene_preview.png b/tutorials/ui/img/scene_preview.png similarity index 100% rename from tutorials/gui/img/scene_preview.png rename to tutorials/ui/img/scene_preview.png diff --git a/tutorials/gui/img/shake.png b/tutorials/ui/img/shake.png similarity index 100% rename from tutorials/gui/img/shake.png rename to tutorials/ui/img/shake.png diff --git a/tutorials/ui/img/skinbuttons1.png b/tutorials/ui/img/skinbuttons1.png new file mode 100644 index 000000000..226bd90dc Binary files /dev/null and b/tutorials/ui/img/skinbuttons1.png differ diff --git a/tutorials/ui/img/skinbuttons2.png b/tutorials/ui/img/skinbuttons2.png new file mode 100644 index 000000000..b6a79ef6d Binary files /dev/null and b/tutorials/ui/img/skinbuttons2.png differ diff --git a/tutorials/gui/img/tank-kings-by-winterpixel-games.png b/tutorials/ui/img/tank-kings-by-winterpixel-games.png similarity index 100% rename from tutorials/gui/img/tank-kings-by-winterpixel-games.png rename to tutorials/ui/img/tank-kings-by-winterpixel-games.png diff --git a/tutorials/gui/img/theme_editor.png b/tutorials/ui/img/theme_editor.png similarity index 100% rename from tutorials/gui/img/theme_editor.png rename to tutorials/ui/img/theme_editor.png diff --git a/tutorials/gui/img/theme_item_inspector.png b/tutorials/ui/img/theme_item_inspector.png similarity index 100% rename from tutorials/gui/img/theme_item_inspector.png rename to tutorials/ui/img/theme_item_inspector.png diff --git a/tutorials/gui/img/theme_pin_the_stylebox.png b/tutorials/ui/img/theme_pin_the_stylebox.png similarity index 100% rename from tutorials/gui/img/theme_pin_the_stylebox.png rename to tutorials/ui/img/theme_pin_the_stylebox.png diff --git a/tutorials/gui/img/theme_preview_picker.png b/tutorials/ui/img/theme_preview_picker.png similarity index 100% rename from tutorials/gui/img/theme_preview_picker.png rename to tutorials/ui/img/theme_preview_picker.png diff --git a/tutorials/gui/img/theme_type_editor.png b/tutorials/ui/img/theme_type_editor.png similarity index 100% rename from tutorials/gui/img/theme_type_editor.png rename to tutorials/ui/img/theme_type_editor.png diff --git a/tutorials/gui/img/themecheck.png b/tutorials/ui/img/themecheck.png similarity index 100% rename from tutorials/gui/img/themecheck.png rename to tutorials/ui/img/themecheck.png diff --git a/tutorials/ui/img/themeci.png b/tutorials/ui/img/themeci.png new file mode 100644 index 000000000..5075df1fc Binary files /dev/null and b/tutorials/ui/img/themeci.png differ diff --git a/tutorials/ui/img/themeci2.png b/tutorials/ui/img/themeci2.png new file mode 100644 index 000000000..060f645be Binary files /dev/null and b/tutorials/ui/img/themeci2.png differ diff --git a/tutorials/ui/img/themeci3.png b/tutorials/ui/img/themeci3.png new file mode 100644 index 000000000..d0e80f367 Binary files /dev/null and b/tutorials/ui/img/themeci3.png differ diff --git a/tutorials/gui/img/tornado.png b/tutorials/ui/img/tornado.png similarity index 100% rename from tutorials/gui/img/tornado.png rename to tutorials/ui/img/tornado.png diff --git a/tutorials/gui/img/wave.png b/tutorials/ui/img/wave.png similarity index 100% rename from tutorials/gui/img/wave.png rename to tutorials/ui/img/wave.png diff --git a/tutorials/ui/index.rst b/tutorials/ui/index.rst new file mode 100644 index 000000000..beee2b3e1 --- /dev/null +++ b/tutorials/ui/index.rst @@ -0,0 +1,36 @@ +User Interface (UI) +=================== + +.. toctree:: + :maxdepth: 1 + :name: toc-gui-basics + + size_and_anchors + gui_containers + custom_gui_controls + gui_navigation + control_node_gallery + +GUI skinning and themes +----------------------- + +Godot features an in-depth skinning/theming system for control nodes. The pages in this section +explain the benefits of that system and how to set it up in your projects. + +.. toctree:: + :maxdepth: 1 + :name: toc-gui-skinning + + gui_skinning + gui_using_theme_editor + +Control node tutorials +---------------------- + +The following articles cover specific details of using particular control nodes. + +.. toctree:: + :maxdepth: 1 + :name: toc-control-nodes-tutorials + + bbcode_in_richtextlabel diff --git a/tutorials/gui/size_and_anchors.rst b/tutorials/ui/size_and_anchors.rst similarity index 100% rename from tutorials/gui/size_and_anchors.rst rename to tutorials/ui/size_and_anchors.rst