Siklos/blueprint-compiler
1
0
Fork 0
mirror of https://gitlab.gnome.org/jwestman/blueprint-compiler.git synced 2025-05-04 15:59:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tutorial: Fixed a broken link, and some other tweaks.

Browse source
This commit is contained in:
Megadash452 2022-10-19 12:39:14 +00:00
parent ba8ec80456
commit 13e477aa25
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/tutorial.rst
View file

@ -81,13 +81,13 @@ Other namespaces must be written explicitly.
Consult the widget library's documentation for a list of widgets. Consult the widget library's documentation for a list of widgets.
A good place to start is A good place to start is
`the Gtk4 widget list <https://docs.gtk.org/gtk4/index.html>`. `the Gtk4 widget list <https://docs.gtk.org/gtk4/index.html>`_.
Naming Widgets Naming Widgets
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Widgets can be given a **name/ID** so that they can be referenced by other Widgets can be given a **name/ID** so that they can be referenced by your
widgets in the blueprint. program or other widgets in the blueprint.
.. code-block:: .. code-block::
@ -178,7 +178,7 @@ OR
} }
Note the use of a semicolon at the end of the property in both cases. Note the use of a semicolon at the end of the property in both cases.
Widget properties are not exempt of this rule. Inline widget properties are not exempt of this rule.
Property Bindings Property Bindings
@ -261,7 +261,7 @@ your language's bindings of Gtk.
By default, signals in the blueprint will pass the widget that the signal By default, signals in the blueprint will pass the widget that the signal
is for as an argument to the *handler*. However, you can specify the is for as an argument to the *handler*. However, you can specify the
widget that is passed to the handler by referencing its **id** inside the widget that is passed to the handler by referencing its **ID** inside the
parenthesis. parenthesis.
.. code-block:: .. code-block::
@ -278,11 +278,11 @@ parenthesis.
Custom Widget Classes Custom Widget Classes
--------------------- ---------------------
Some programs have custom widgets defined in their logic, and so blueprint Some programs have custom widgets defined in their logic, so blueprint
won't know that they exist. Writing widgets not defined in the GIR will won't know that they exist. Writing widgets not defined in the GIR will
result in an error. Prepend a custom widget with a ``.`` to prevent the result in an error. Prepend a custom widget with a ``.`` to prevent the
compiler from trying to validate the widget. This is essentially leaving compiler from trying to validate the widget. This is essentially saying
out the *namespace*. the widget has no *namespace*.
To register a custom widget with the application consult the documentation To register a custom widget with the application consult the documentation
for your language's bindings of Gtk. for your language's bindings of Gtk.
@ -340,7 +340,7 @@ be used for any widget. Similarly to how every widget has styles,
] ]
} }
See `examples <examples.html>`_ for a list of more of these See :doc:`examples <examples#widget-specific-items>` for a list of more of these
widget-specific items. widget-specific items.
@ -348,7 +348,7 @@ Menus
----- -----
Menus are usually the widgets that are placed along the top-bar of a Menus are usually the widgets that are placed along the top-bar of a
window, or pop up when you right-click some other widget. In Blueprint a window, or pop up when you right-click some other widget. In Blueprint, a
``menu`` is a ``Gio.MenuModel`` that can be shown by MenuButtons or other ``menu`` is a ``Gio.MenuModel`` that can be shown by MenuButtons or other
widgets. widgets.
@ -410,7 +410,7 @@ Child Types
----------- -----------
Child types describe how a child widget is placed on a parent widget. For Child types describe how a child widget is placed on a parent widget. For
example, HeaderBars widgets can have children placed either at the *start* example, HeaderBar widgets can have children placed either at the *start*
or the *end* of the Headerbar. Child widgets of HeaderBars can have the or the *end* of the Headerbar. Child widgets of HeaderBars can have the
*start* or *end* types. Values for child types a widget can have are *start* or *end* types. Values for child types a widget can have are
defined in the widget's documentation. defined in the widget's documentation.