| | | | |
| Offset 1, 32 lines modified | Offset 1, 8 lines modified |
| 1 | { | 1 | { |
| 2 | ····"Syntax·Root":·{ | |
| 3 | ········"content":·"\n##·Document·Root\n\n```text\nRoot·=·GtkDecl·(Using)*·(TranslationDomain)?·(·Template·|·Menu·|·Object·)*·EOF\n```\n\nA·blueprint·document·consists·of·a·[GTK·declaration](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-gtkdecl),·one·or·more·[imports](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-using),·and·a·list·of·[objects](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-object)·and/or·a·[template](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/templates.html#syntax-template).\n\n###·Example\n\n```blueprint\n//·Gtk·Declaration\nusing·Gtk·4.0;\n\n//·Import·Statement\nusing·Adw·1;\n\n//·Object\nWindow·my_window·{}\n```\n\n", | |
| 4 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-root" | |
| 5 | ····}, | |
| 6 | ····"Syntax·GtkDecl":·{ | |
| 7 | ········"content":·"\n##·GTK·Declaration\n\n```text\nGtkDecl·=·'using'·'Gtk'·'4.0'·';'\n```\n\nEvery·blueprint·file·begins·with·the·line·`using·Gtk·4.0;`,·which·declares·the·target·GTK·version·for·the·file.·Tools·that·read·blueprint·files·should·verify·that·they·support·the·declared·version.\n\n###·Example\n\n```blueprint\nusing·Gtk·4.0;\n```\n\n", | |
| 8 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-gtkdecl" | |
| 9 | ····}, | |
| 10 | ····"Syntax·Using":·{ | |
| 11 | ········"content":·"\n##·GObject·Introspection·Imports\n\n```text\nUsing·=·'using'·<namespace:IDENT>·<version:NUMBER>·';'\n```\n\nTo·use·classes·and·types·from·namespaces·other·than·GTK·itself,·those·namespaces·must·be·imported·at·the·top·of·the·file.·This·tells·the·compiler·what·version·of·the·namespace·to·import.\n\nYou'll·need·the·GIR·name·and·version,·not·the·package·name·and·not·the·exact·version·number.·These·are·listed·at·the·top·of·each·library's·documentation·homepage:\n\n\n\nThe·compiler·requires·typelib·files·for·these·libraries·to·be·installed.·They·are·usually·installed·with·the·library,·but·on·some·distros,·you·may·need·to·install·the·package·that·provides·`{namespace}-{version}.typelib`·(e.g.·`Adw-1.typelib`).\n\n###·Example\n\n```blueprint\n//·Import·libadwaita\nusing·Adw·1;\n```\n\n", | |
| 12 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-using" | |
| 13 | ····}, | |
| 14 | ····"Syntax·TranslationDomain":·{ | |
| 15 | ········"content":·"\n##·Translation·Domain\n\n```text\nTranslationDomain·=·'translation-domain'·<domain:QUOTED>·';'\n```\n\nThe·translation·domain·is·used·to·look·up·translations·for·translatable·strings·in·the·blueprint·file.·If·no·translation·domain·is·specified,·strings·will·be·looked·up·in·the·program's·global·domain.\n\nSee·[Gtk.Builder:translation-domain](https://docs.gtk.org/gtk4/property.Builder.translation-domain.html)·for·more·information.\n", | |
| 16 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-translationdomain" | |
| 17 | ····}, | |
| 18 | ····"Syntax·Menu":·{ | |
| 19 | ········"content":·"\n##·Menus\n\n```text\nMenu·=·'menu'·<id:IDENT>?·'{'·MenuChild*·'}'\nMenuChild·=·(·MenuSection·|·MenuSubmenu·|·MenuItemShorthand·|·MenuItem·)\nMenuSection·=·'section'·<id:IDENT>?·'{'·(·MenuChild·|·MenuAttribute·)*·'}'\nMenuSubmenu·=·'submenu'·<id:IDENT>?·'{'·(·MenuChild·|·MenuAttribute·)*·'}'\nMenuItem·=·'item'·'{'·MenuAttribute*·'}'\nMenuAttribute·=·<name:IDENT>·':'·StringValue·';'\n```\n\nMenus,·such·as·the·application·menu,·are·defined·using·the·`menu`·keyword.·Menus·have·the·type·[Gio.MenuModel](https://docs.gtk.org/gio/class.MenuModel.html)·and·can·be·referenced·by·ID.·They·cannot·be·defined·inline.\n\n###·Example\n\n```blueprint\nmenu·my_menu·{\n··submenu·{\n····label:·_(\"File\");\n····item·{\n······label:·_(\"New\");\n······action:·\"app.new\";\n······icon:·\"document-new-symbolic\";\n····}\n··}\n}\n\nMenuButton·{\n··menu-model:·my_menu;\n}\n```\n\n", | |
| 20 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/menus.html#syntax-menu" | |
| 21 | ····}, | |
| 22 | ····"Syntax·MenuItemShorthand":·{ | |
| 23 | ········"content":·"\n##·Item·Shorthand\n\n```text\nMenuItemShorthand·=·'item'·'('·StringValue·(·','·(·StringValue·(·','·StringValue?·)?·)?·)?·')'\n```\n\nThe·most·common·menu·attributes·are·`label`,·`action`,·and·`icon`.·Because·they're·so·common,·Blueprint·provides·a·shorter·syntax·for·menu·items·with·just·these·properties.\n\n###·Example\n\n```blueprint\nmenu·{\n··item·(\"label\")\n··item·(\"label\",·\"action\")\n··item·(\"label\",·\"action\",·\"icon\")\n}\n```\n\n", | |
| 24 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/menus.html#syntax-menuitemshorthand" | |
| 25 | ····}, | |
| 26 | ····"Diagnostic·abstract_class":·{ | 2 | ····"Diagnostic·abstract_class":·{ |
| 27 | ········"content":·"\n##·abstract_class\nObjects·can't·be·created·from·abstract·classes.·Abstract·classes·are·used·as·base·classes·for·other·classes,·but·they·don't·have·functionality·on·their·own.·You·may·want·to·use·a·non-abstract·subclass·instead.\n\n\n", | 3 | ········"content":·"\n##·abstract_class\nObjects·can't·be·created·from·abstract·classes.·Abstract·classes·are·used·as·base·classes·for·other·classes,·but·they·don't·have·functionality·on·their·own.·You·may·want·to·use·a·non-abstract·subclass·instead.\n\n\n", |
| 28 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-abstract-class" | 4 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-abstract-class" |
| 29 | ····}, | 5 | ····}, |
| 30 | ····"Diagnostic·bad_syntax":·{ | 6 | ····"Diagnostic·bad_syntax":·{ |
| 31 | ········"content":·"\n##·bad_syntax\nThe·tokenizer·encountered·an·unexpected·sequence·of·characters·that·aren't·part·of·any·known·blueprint·syntax.\n\n\n", | 7 | ········"content":·"\n##·bad_syntax\nThe·tokenizer·encountered·an·unexpected·sequence·of·characters·that·aren't·part·of·any·known·blueprint·syntax.\n\n\n", |
| 32 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-bad-syntax" | 8 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-bad-syntax" |
| Offset 111, 14 lines modified | Offset 87, 18 lines modified |
| 111 | ········"content":·"\n##·version_conflict\nThis·error·occurs·when·two·versions·of·a·namespace·are·imported·(possibly·transitively)·in·the·same·file.·For·example,·this·will·cause·a·version·conflict:\n\n```blueprint\nusing·Gtk·4.0;\nusing·Gtk·3.0;\n```\n\nBut·so·will·this:\n\n```blueprint\nusing·Gtk·4.0;\nusing·Handy·1;\n```\n\nbecause·libhandy·imports·`Gtk·3.0`.\n\n\n", | 87 | ········"content":·"\n##·version_conflict\nThis·error·occurs·when·two·versions·of·a·namespace·are·imported·(possibly·transitively)·in·the·same·file.·For·example,·this·will·cause·a·version·conflict:\n\n```blueprint\nusing·Gtk·4.0;\nusing·Gtk·3.0;\n```\n\nBut·so·will·this:\n\n```blueprint\nusing·Gtk·4.0;\nusing·Handy·1;\n```\n\nbecause·libhandy·imports·`Gtk·3.0`.\n\n\n", |
| 112 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-version-conflict" | 88 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-version-conflict" |
| 113 | ····}, | 89 | ····}, |
| 114 | ····"Diagnostic·wrong_compiler_version":·{ | 90 | ····"Diagnostic·wrong_compiler_version":·{ |
| 115 | ········"content":·"\n##·wrong_compiler_version\nThis·version·of·blueprint-compiler·is·for·GTK·4·blueprints·only.·Future·GTK·versions·will·use·different·versions·of·blueprint-compiler.\n", | 91 | ········"content":·"\n##·wrong_compiler_version\nThis·version·of·blueprint-compiler·is·for·GTK·4·blueprints·only.·Future·GTK·versions·will·use·different·versions·of·blueprint-compiler.\n", |
| 116 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-wrong-compiler-version" | 92 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/diagnostics.html#diagnostic-wrong-compiler-version" |
| 117 | ····}, | 93 | ····}, |
| | 94 | ····"Syntax·Template":·{ |
| | 95 | ········"content":·"\n##·Composite·Templates\n\n```text\nTemplate·=·'template'·TypeName·(·':'·TypeName·)?·ObjectContent\n```\n\nWidget·subclassing·is·one·of·the·primary·techniques·for·structuring·an·application.·For·example,·a·maps·app·might·have·a·[Gtk.ApplicationWindow](https://docs.gtk.org/gtk4/class.ApplicationWindow.html)·subclass,·`MapsApplicationWindow`,·that·implements·the·functionality·of·its·main·window.·But·a·maps·app·has·a·lot·of·functionality,·so·the·headerbar·might·be·split·into·its·own·[Gtk.HeaderBar](https://docs.gtk.org/gtk4/class.HeaderBar.html)·subclass,·`MapsHeaderBar`,·for·the·sake·of·organization.\n\nYou·could·implement·this·with·the·following·blueprint:\n\n```blueprint\nusing·Gtk·4.0;\n\n$MapsApplicationWindow·window·{\n··$MapsHeaderBar·{\n····/*·probably·a·lot·of·buttons·...·*/\n··}\n\n··$MapsMainView·{\n····/*·a·lot·more·UI·definitions·...·*/\n··}\n}\n```\n\nThere·are·two·problems·with·this·approach:\n\n1.·The·widget·code·may·be·organized·neatly·into·different·files,·but·the·UI·is·not.·This·blueprint·contains·the·entire·UI·definition·for·the·app.\n\n2.·Widgets·aren't·in·control·of·their·own·contents.·It·shouldn't·be·up·to·the·caller·to·construct·a·widget·using·the·correct·blueprint--that's·an·implementation·detail·of·the·widget.\n\nWe·can·solve·these·problems·by·giving·each·widget·its·own·blueprint·file,·which·we·reference·in·the·widget's·constructor.·Then,·whenever·the·widget·is·instantiated·(by·another·blueprint,·or·by·the·application),·it·will·get·all·the·children·and·properties·defined·in·its·blueprint.\n\nFor·this·to·work,·we·need·to·specify·in·the·blueprint·which·object·is·the·one·being·instantiated.·We·do·this·with·a·template·block:\n\n```blueprint\nusing·Gtk·4.0;\n\ntemplate·$MapsHeaderBar·:·Gtk.HeaderBar·{\n··/*·probably·a·lot·of·buttons·...·*/\n}\n\nGio.ListStore·bookmarked_places_store·{\n··/*·This·isn't·the·object·being·instantiated,·just·an·auxillary·object.·GTK·knows·this·because·it·isn't·the\n·····one·marked·with·'template'.·*/\n}\n```\n\nThis·blueprint·can·only·be·used·by·the·`MapsHeaderBar`·constructor.·Instantiating·it·with·`Gtk.Builder`·won't·work·since·it·needs·an·existing,·under-construction·`MapsHeaderBar`·to·use·for·the·template·object.·The·`template`·block·must·be·at·the·top·level·of·the·file·(not·nested·within·another·object)·and·only·one·is·allowed·per·file.\n\nThis·`MapsHeaderBar`·class,·along·with·its·blueprint·template,·can·then·be·referenced·in·another·blueprint:\n\n```blueprint\nusing·Gtk·4.0;\n\nApplicationWindow·{\n··$MapsHeaderBar·{\n····/*·Nothing·needed·here,·the·widgets·are·in·the·MapsHeaderBar·template.·*/\n··}\n}\n```\n\n###·Type·&·Parent·Parameters\n\nThe·type·name·that·directly·follows·the·`template`·keyword·is·the·type·of·the·template·class.·In·most·cases,·this·will·be·an·extern·type·starting·with·`$`·and·matching·the·class·name·in·the·application·code.·Templates·for·use·in·a·[Gtk.BuilderListItemFactory](https://docs.gtk.org/gtk4/class.BuilderListItemFactory.html)·use·`ListItem`·as·the·type·name·instead.\n\nThe·parent·type·is·optional,·and·may·only·be·present·if·the·template·type·is·extern.·It·enables·limited·type·checking·for·the·properties·and·signals·of·the·template·object.\n\n\n##·Referencing·a·Template\n\nTo·reference·the·template·object·in·a·binding·or·expression,·use·the·`template`·keyword:\n\n```blueprint\ntemplate·$MyTemplate·{\n··prop1:·\"Hello,·world!\";\n··prop2:·bind·template.prop1;\n}\n```\n\n##·Language·Implementations\n\n-·**C**·`gtk_widget_class_set_template·()`:·https://docs.gtk.org/gtk4/class.Widget.html#building-composite-widgets-from-template-xml\n-·**gtk-rs**·`#[template]`:·https://gtk-rs.org/gtk4-rs/stable/latest/book/composite_templates.html\n-·**GJS**·`GObject.registerClass()`:·https://gjs.guide/guides/gtk/3/14-templates.html\n-·**PyGObject**·`@Gtk.Template`:·https://pygobject.gnome.org/guide/gtk_template.html\n", |
| | 96 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/templates.html#syntax-template" |
| | 97 | ····}, |
| 118 | ····"Syntax·Object":·{ | 98 | ····"Syntax·Object":·{ |
| 119 | ········"content":·"\n##·Objects\n\n```text\nObject·=·TypeName·<id:IDENT>?·ObjectContent\nObjectContent·=·'{'·(Signal·|·Property·|·Extension·|·Child)*·'}'\n```\n\nObjects·are·the·basic·building·blocks·of·a·GTK·user·interface.·Your·widgets·are·all·objects,·as·are·some·other·features·such·as·list·models.\n\nOptionally,·objects·may·have·an·ID·to·provide·a·handle·for·other·parts·of·the·blueprint·and·your·code·to·access·objects.\n\n####·Note\n\nObject·IDs·must·be·unique·within·their·scope.·The·document·root·is·a·scope,·but·[sub-templates](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/extensions.html#syntax-extlistitemfactory)·have·their·own,·isolated·scope.\n\n###·Example\n\n```blueprint\nLabel·label1·{\n··label:·\"Hello,·world!\";\n}\nLabel·label2·{\n··label:·bind-property·file.name;\n}\n```\n\n", | 99 | ········"content":·"\n##·Objects\n\n```text\nObject·=·TypeName·<id:IDENT>?·ObjectContent\nObjectContent·=·'{'·(Signal·|·Property·|·Extension·|·Child)*·'}'\n```\n\nObjects·are·the·basic·building·blocks·of·a·GTK·user·interface.·Your·widgets·are·all·objects,·as·are·some·other·features·such·as·list·models.\n\nOptionally,·objects·may·have·an·ID·to·provide·a·handle·for·other·parts·of·the·blueprint·and·your·code·to·access·objects.\n\n####·Note\n\nObject·IDs·must·be·unique·within·their·scope.·The·document·root·is·a·scope,·but·[sub-templates](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/extensions.html#syntax-extlistitemfactory)·have·their·own,·isolated·scope.\n\n###·Example\n\n```blueprint\nLabel·label1·{\n··label:·\"Hello,·world!\";\n}\nLabel·label2·{\n··label:·bind-property·file.name;\n}\n```\n\n", |
| 120 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-object" | 100 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-object" |
| 121 | ····}, | 101 | ····}, |
| 122 | ····"Syntax·TypeName":·{ | 102 | ····"Syntax·TypeName":·{ |
| 123 | ········"content":·"\n##·Type·Names\n\n```text\nTypeName·=·TypeNameFull·|·TypeNameExternal·|·TypeNameShort\nTypeNameFull·=·<namespace:IDENT>·'.'·<name:IDENT>\nTypeNameExternal·=·'$'·<name:IDENT>\nTypeNameShort·=·<name:IDENT>\n```\n\nThere·are·three·forms·of·type·names:·full,·short,·and·external.·Full·type·names·take·the·form·`{namespace}.{name}`,·e.g.·`Gtk.ApplicationWindow`·or·`Adw.Leaflet`.·Because·GTK·types·are·so·common,·the·Gtk·namespace·may·be·omitted,·shortening·`Gtk.ApplicationWindow`·to·just·`ApplicationWindow`.\n\nExternal·type·names·refer·to·types·defined·in·your·application.·They·are·prefixed·with·`$`·and·do·not·have·a·dot·between·the·namespace·and·class·name.·In·fact,·anywhere·a·`$`·is·used·in·a·blueprint,·it·refers·to·something·that·must·be·defined·in·your·application·code.\n\n\n", | 103 | ········"content":·"\n##·Type·Names\n\n```text\nTypeName·=·TypeNameFull·|·TypeNameExternal·|·TypeNameShort\nTypeNameFull·=·<namespace:IDENT>·'.'·<name:IDENT>\nTypeNameExternal·=·'$'·<name:IDENT>\nTypeNameShort·=·<name:IDENT>\n```\n\nThere·are·three·forms·of·type·names:·full,·short,·and·external.·Full·type·names·take·the·form·`{namespace}.{name}`,·e.g.·`Gtk.ApplicationWindow`·or·`Adw.Leaflet`.·Because·GTK·types·are·so·common,·the·Gtk·namespace·may·be·omitted,·shortening·`Gtk.ApplicationWindow`·to·just·`ApplicationWindow`.\n\nExternal·type·names·refer·to·types·defined·in·your·application.·They·are·prefixed·with·`$`·and·do·not·have·a·dot·between·the·namespace·and·class·name.·In·fact,·anywhere·a·`$`·is·used·in·a·blueprint,·it·refers·to·something·that·must·be·defined·in·your·application·code.\n\n\n", |
| 124 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-typename" | 104 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-typename" |
| Offset 131, 17 lines modified | Offset 111, 77 lines modified |
| 131 | ········"content":·"\n##·Signal·Handlers\n\n```text\nSignal·=·<name:IDENT>·('::'·<detail:IDENT>)?·'=>'·'$'·<handler:IDENT>·'('·<object:IDENT>?·')'·(SignalFlag)*·';'\nSignalFlag·=·'after'·|·'swapped'·|·'not-swapped'\n```\n\nSignals·are·one·way·to·respond·to·user·input·(another·is·[actions](https://docs.gtk.org/gtk4/actions.html),·which·use·the·[action-name·property](https://docs.gtk.org/gtk4/property.Actionable.action-name.html)).\n\nSignals·provide·a·handle·for·your·code·to·listen·to·events·in·the·UI.·The·handler·name·is·prefixed·with·`$`·to·indicate·that·it's·an·external·symbol·which·needs·to·be·provided·by·your·code;·if·it·isn't,·things·might·not·work·correctly,·or·at·all.\n\nOptionally,·you·can·provide·an·object·ID·to·use·when·connecting·the·signal.\n\nThe·`swapped`·flag·is·used·to·swap·the·order·of·the·object·and·userdata·arguments·in·C·applications.·If·an·object·argument·is·specified,·then·this·is·the·default·behavior,·so·the·`not-swapped`·flag·can·be·used·to·prevent·the·swap.\n\n###·Example\n\n```blueprint\nButton·{\n··clicked·=>·$on_button_clicked();\n}\n```\n\n", | 111 | ········"content":·"\n##·Signal·Handlers\n\n```text\nSignal·=·<name:IDENT>·('::'·<detail:IDENT>)?·'=>'·'$'·<handler:IDENT>·'('·<object:IDENT>?·')'·(SignalFlag)*·';'\nSignalFlag·=·'after'·|·'swapped'·|·'not-swapped'\n```\n\nSignals·are·one·way·to·respond·to·user·input·(another·is·[actions](https://docs.gtk.org/gtk4/actions.html),·which·use·the·[action-name·property](https://docs.gtk.org/gtk4/property.Actionable.action-name.html)).\n\nSignals·provide·a·handle·for·your·code·to·listen·to·events·in·the·UI.·The·handler·name·is·prefixed·with·`$`·to·indicate·that·it's·an·external·symbol·which·needs·to·be·provided·by·your·code;·if·it·isn't,·things·might·not·work·correctly,·or·at·all.\n\nOptionally,·you·can·provide·an·object·ID·to·use·when·connecting·the·signal.\n\nThe·`swapped`·flag·is·used·to·swap·the·order·of·the·object·and·userdata·arguments·in·C·applications.·If·an·object·argument·is·specified,·then·this·is·the·default·behavior,·so·the·`not-swapped`·flag·can·be·used·to·prevent·the·swap.\n\n###·Example\n\n```blueprint\nButton·{\n··clicked·=>·$on_button_clicked();\n}\n```\n\n", |
| 132 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-signal" | 112 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-signal" |
| 133 | ····}, | 113 | ····}, |
| 134 | ····"Syntax·Child":·{ | 114 | ····"Syntax·Child":·{ |
| 135 | ········"content":·"\n##·Children\n\n```text\nChild·=·ChildAnnotation?·Object\nChildAnnotation·=·'['·(·ChildInternal·|·ChildExtension·|·ChildType·)·']'\nChildInternal·=·'internal-child'·<internal-child:IDENT>\nChildType·=·<child_type:IDENT>\n```\n\nSome·objects·can·have·children.·This·defines·the·hierarchical·structure·of·a·user·interface:·containers·contain·widgets,·which·can·be·other·containers,·and·so·on.\n\nChild·annotations·are·defined·by·the·parent·widget.·Some·widgets,·such·as·[HeaderBar](https://docs.gtk.org/gtk4/class.HeaderBar.html),·have·\"child·types\"·which·allow·different·child·objects·to·be·treated·in·different·ways.·Some,·such·as·[Dialog](https://docs.gtk.org/gtk4/class.Dialog.html)·and·[InfoBar](https://docs.gtk.org/gtk4/class.InfoBar.html),·define·child·[extensions](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/extensions.html#syntax-childextension),·which·provide·more·detailed·information·about·the·child.\n\nInternal·children·are·a·special·case.·Rather·than·creating·a·new·object,·children·marked·with·`[internal-child·<name>]`·modify·an·existing·object·provided·by·the·parent.·This·is·used,·for·example,·for·the·`content_area`·of·a·[Dialog](https://docs.gtk.org/gtk4/class.Dialog.html).\n\n####·Note\n\nThe·objects·at·the·root·of·a·blueprint·cannot·have·child·annotations,·since·there·is·no·root·widget·for·them·to·be·a·child·of.\n\n####·Note\n\nSome·widgets,·like·[Button](https://docs.gtk.org/gtk4/class.Button.html),·use·a·property·to·set·their·child·instead.·Widgets·added·in·this·way·don't·have·child·annotations.\n\n###·Examples\n\n####·Add·children·to·a·container\n\n```blueprint\nButton·{\n··Image·{}\n}\n```\n\n####·Child·types\n\n```blueprint\nHeaderBar·{\n··[start]\n··Label·{\n··}\n\n··[end]\n··Button·{\n··}\n}\n```\n\n####·Child·extensions\n\n```blueprint\nDialog·{\n··//·Here,·a·child·extension·annotation·defines·the·button's·response.\n··[action·response=cancel]\n··Button·{}\n}\n```\n\n####·Internal·children\n\n```blueprint\nDialog·{\n··[internal-child·content_area]\n··Box·{\n····//·Unlike·most·objects·in·a·blueprint,·this·internal-child·widget\n····//·represents·the·properties,·signal·handlers,·children,·and·extensions\n····//·of·an·existing·Box·created·by·the·Dialog,·not·a·new·Box·created·by\n····//·the·blueprint.\n··}\n}\n```\n\n", | 115 | ········"content":·"\n##·Children\n\n```text\nChild·=·ChildAnnotation?·Object\nChildAnnotation·=·'['·(·ChildInternal·|·ChildExtension·|·ChildType·)·']'\nChildInternal·=·'internal-child'·<internal-child:IDENT>\nChildType·=·<child_type:IDENT>\n```\n\nSome·objects·can·have·children.·This·defines·the·hierarchical·structure·of·a·user·interface:·containers·contain·widgets,·which·can·be·other·containers,·and·so·on.\n\nChild·annotations·are·defined·by·the·parent·widget.·Some·widgets,·such·as·[HeaderBar](https://docs.gtk.org/gtk4/class.HeaderBar.html),·have·\"child·types\"·which·allow·different·child·objects·to·be·treated·in·different·ways.·Some,·such·as·[Dialog](https://docs.gtk.org/gtk4/class.Dialog.html)·and·[InfoBar](https://docs.gtk.org/gtk4/class.InfoBar.html),·define·child·[extensions](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/extensions.html#syntax-childextension),·which·provide·more·detailed·information·about·the·child.\n\nInternal·children·are·a·special·case.·Rather·than·creating·a·new·object,·children·marked·with·`[internal-child·<name>]`·modify·an·existing·object·provided·by·the·parent.·This·is·used,·for·example,·for·the·`content_area`·of·a·[Dialog](https://docs.gtk.org/gtk4/class.Dialog.html).\n\n####·Note\n\nThe·objects·at·the·root·of·a·blueprint·cannot·have·child·annotations,·since·there·is·no·root·widget·for·them·to·be·a·child·of.\n\n####·Note\n\nSome·widgets,·like·[Button](https://docs.gtk.org/gtk4/class.Button.html),·use·a·property·to·set·their·child·instead.·Widgets·added·in·this·way·don't·have·child·annotations.\n\n###·Examples\n\n####·Add·children·to·a·container\n\n```blueprint\nButton·{\n··Image·{}\n}\n```\n\n####·Child·types\n\n```blueprint\nHeaderBar·{\n··[start]\n··Label·{\n··}\n\n··[end]\n··Button·{\n··}\n}\n```\n\n####·Child·extensions\n\n```blueprint\nDialog·{\n··//·Here,·a·child·extension·annotation·defines·the·button's·response.\n··[action·response=cancel]\n··Button·{}\n}\n```\n\n####·Internal·children\n\n```blueprint\nDialog·{\n··[internal-child·content_area]\n··Box·{\n····//·Unlike·most·objects·in·a·blueprint,·this·internal-child·widget\n····//·represents·the·properties,·signal·handlers,·children,·and·extensions\n····//·of·an·existing·Box·created·by·the·Dialog,·not·a·new·Box·created·by\n····//·the·blueprint.\n··}\n}\n```\n\n", |
| 136 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-child" | 116 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-child" |
| 137 | ····}, | 117 | ····}, |
| | 118 | ····"Syntax·Value":·{ |
| | 119 | ········"content":·"\n##·Values\n\n```text\nValue·=·Translated·|·Flags·|·Literal\n```\n\n", |
| | 120 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-value" |
| | 121 | ····}, |
| | 122 | ····"Syntax·Literal":·{ |
| | 123 | ········"content":·"\n##·Literals\n\n```text\nLiteral·=·TypeLiteral·|·QuotedLiteral·|·NumberLiteral·|·IdentLiteral\nQuotedLiteral·=·<value:QUOTED>\nNumberLiteral·=·(·'-'·|·'+'·)?·<value:NUMBER>\nIdentLiteral·=·<ident:IDENT>\n```\n\nLiterals·are·used·to·specify·values·for·properties.·They·can·be·strings,·numbers,·references·to·objects,·`null`,·types,·boolean·values,·or·enum·members.\n\n", |
| | 124 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-literal" |
| | 125 | ····}, |
| | 126 | ····"Syntax·TypeLiteral":·{ |
| | 127 | ········"content":·"\n##·Type·Literals\n\n```text\nTypeLiteral·=·'typeof'·'<'·TypeName·'>'\n```\n\nSometimes,·you·need·to·specify·a·type·as·a·value.·For·example,·when·creating·a·list·store,·you·may·need·to·specify·the·type·of·the·items·in·the·list·store.·This·is·done·using·a·`typeof<>`·literal.\n\nThe·type·of·a·`typeof<>`·literal·is·[GType](https://docs.gtk.org/gobject/alias.Type.html),·GObject's·\"meta-type\"·for·type·information.\n\n\n###·Example\n\n```blueprint\nGio.ListStore·{\n··item-type:·typeof<GObject.Object>;\n}\n```\n\n", |
| | 128 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-typeliteral" |
| | 129 | ····}, |
| | 130 | ····"Syntax·Flags":·{ |
| | 131 | ········"content":·"\n##·Flags\n\n```text\nFlags·=·<first:IDENT>·'|'·(·<rest:IDENT>·)|+\n```\n\nFlags·are·used·to·specify·a·set·of·options.·One·or·more·of·the·available·flag·values·may·be·specified,·and·they·are·combined·using·`|`.\n\n###·Example\n\n```blueprint\nAdw.TabView·{\n··shortcuts:·control_tab·|·control_shift_tab;\n}\n```\n\n", |
| | 132 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-flags" |
| | 133 | ····}, |
| 138 | ····"Syntax·Template":·{ | 134 | ····"Syntax·Translated":·{ |
| 139 | ········"content":·"\n##·Composite·Templates\n\n```text\nTemplate·=·'template'·TypeName·(·':'·TypeName·)?·ObjectContent\n```\n\nWidget·subclassing·is·one·of·the·primary·techniques·for·structuring·an·application.·For·example,·a·maps·app·might·have·a·[Gtk.ApplicationWindow](https://[·...·truncated·by·diffoscope;·len:·3590,·SHA:·d41ffde35e9a606da429ab8090d8224ba705212d7a45747e7acfed02875ecfc7·...·]\n", | 135 | ········"content":·"\n##·Translated·Strings\n\n```text\nTranslated·=·(·'_'·'('·<string:QUOTED>·')'·)·|·(·'\\C_'·'('·<context:QUOTED>·','·<string:QUOTED>·')'·)\n```\n\nUse·`_(\"...\")`·to·mark·strings·as·translatable.·You·can·put·a·comment·for·translators·on·the·line·above·if·neede[·...·truncated·by·diffoscope;·len:·560,·SHA:·04dba4c0ef11cc5188321201ba4ac6dd9ae45fd5db360fbfe989d8307409331a·...·]\n", |
| 140 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/templates.html#syntax-template" | 136 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-translated" |
| | 137 | ····}, |
| | 138 | ····"Syntax·Binding":·{ |
| | 139 | ········"content":·"\n##·Bindings\n\n```text\nBinding·=·'bind'·Expression·(BindingFlag)*\nBindingFlag·=·'inverted'·|·'bidirectional'·|·'no-sync-create'\n```\n\nBindings·keep·a·property·updated·as·other·properties·change.·They·can·be·used·to·keep·the·UI·in·sync·with·application·data,·or·to·connect·two·parts·of·the·UI.\n\nThe·simplest·bindings·connect·to·a·property·of·another·object·in·the·blueprint.·When·that·other·property·changes,·the·bound·property·updates·as·well.·More·advanced·bindings·can·do·multi-step·property·lookups·and·can·even·call·application·code·to·compute·values.·See·[the·expressions·page](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/expressions.html#syntax-expression).\n\n###·Simple·Bindings\n\nA·binding·that·consists·of·a·source·object·and·a·single·lookup·is·called·a·\"simple·binding\".·These·are·implemented·using·[GObject·property·bindings](https://docs.gtk.org/gobject/method.Object.bind_property.html)·and·support·a·few·flags:\n\n-·`inverted`:·For·boolean·properties,·the·target·is·set·to·the·inverse·of·the·source·property.\n-·`bidirectional`:·The·binding·is·two-way,·so·changes·to·the·target·property·will·also·update·the·source·property.\n-·`no-sync-create`:·Normally,·when·a·binding·is·created,·the·target·property·is·immediately·updated·with·the·current·value·of·the·source·property.·This·flag·disables·that·behavior,·and·the·bound·property·will·be·updated·the·next·time·the·source·property·changes.\n\n###·Complex·Bindings\n\nBindings·with·more·complex·expressions·are·implemented·with·[Gtk.Expression](https://docs.gtk.org/gtk4/class.Expression.html).·These·bindings·do·not·support·flags.\n\n###·Example\n\n```blueprint\n/*·Use·bindings·to·show·a·label·when·a·switch\n·*·is·active,·without·any·application·code·*/\n\nSwitch·show_label·{}\n\nLabel·{\n··visible:·bind·show_label.active;\n··label:·_(\"I'm·a·label·that's·only·visible·when·the·switch·is·enabled!\");\n}\n```\n\n", |
| | 140 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-binding" |
| | 141 | ····}, |
| | 142 | ····"Syntax·ObjectValue":·{ |
| | 143 | ········"content":·"\n##·Object·Values\n\n```text\nObjectValue·=·Object\n```\n\nThe·value·of·a·property·can·be·an·object,·specified·inline.·This·is·particularly·useful·for·widgets·that·use·a·`child`·property·rather·than·a·list·of·child·widgets.·Objects·constructed·in·this·way·can·even·have·IDs·and·be·referenced·in·other·places·in·the·blueprint.\n\nSuch·objects·cannot·have·child·annotations·because·they·aren't,·as·far·as·blueprint·is·concerned,·children·of·another·object.\n\n\n", |
| | 144 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-objectvalue" |
| | 145 | ····}, |
| | 146 | ····"Syntax·StringValue":·{ |
| | 147 | ········"content":·"\n##·String·Values\n\n```text\nStringValue·=·Translated·|·QuotedLiteral\n```\n\nMenus,·as·well·as·some·[extensions](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/extensions.html#syntax-extension),·have·properties·that·can·only·be·string·literals·or·translated·strings.\n\n", |
| | 148 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-stringvalue" |
| | 149 | ····}, |
| | 150 | ····"Syntax·ArrayValue":·{ |
| | 151 | ········"content":·"\n##·Array·Values\n\n```text\nArrayValue·=·'['·(StringValue),*·']'\n```\n\nFor·now,·it·only·supports·[Strings](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-stringvalue).·This·is·because·Gtk.Builder·only·supports·string·arrays.\n", |
| | 152 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/values.html#syntax-arrayvalue" |
| | 153 | ····}, |
| | 154 | ····"Syntax·Root":·{ |
| | 155 | ········"content":·"\n##·Document·Root\n\n```text\nRoot·=·GtkDecl·(Using)*·(TranslationDomain)?·(·Template·|·Menu·|·Object·)*·EOF\n```\n\nA·blueprint·document·consists·of·a·[GTK·declaration](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-gtkdecl),·one·or·more·[imports](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-using),·and·a·list·of·[objects](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/objects.html#syntax-object)·and/or·a·[template](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/templates.html#syntax-template).\n\n###·Example\n\n```blueprint\n//·Gtk·Declaration\nusing·Gtk·4.0;\n\n//·Import·Statement\nusing·Adw·1;\n\n//·Object\nWindow·my_window·{}\n```\n\n", |
| | 156 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-root" |
| | 157 | ····}, |
| | 158 | ····"Syntax·GtkDecl":·{ |
| | 159 | ········"content":·"\n##·GTK·Declaration\n\n```text\nGtkDecl·=·'using'·'Gtk'·'4.0'·';'\n```\n\nEvery·blueprint·file·begins·with·the·line·`using·Gtk·4.0;`,·which·declares·the·target·GTK·version·for·the·file.·Tools·that·read·blueprint·files·should·verify·that·they·support·the·declared·version.\n\n###·Example\n\n```blueprint\nusing·Gtk·4.0;\n```\n\n", |
| | 160 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-gtkdecl" |
| | 161 | ····}, |
| | 162 | ····"Syntax·Using":·{ |
| | 163 | ········"content":·"\n##·GObject·Introspection·Imports\n\n```text\nUsing·=·'using'·<namespace:IDENT>·<version:NUMBER>·';'\n```\n\nTo·use·classes·and·types·from·namespaces·other·than·GTK·itself,·those·namespaces·must·be·imported·at·the·top·of·the·file.·This·tells·the·compiler·what·version·of·the·namespace·to·import.\n\nYou'll·need·the·GIR·name·and·version,·not·the·package·name·and·not·the·exact·version·number.·These·are·listed·at·the·top·of·each·library's·documentation·homepage:\n\n\n\nThe·compiler·requires·typelib·files·for·these·libraries·to·be·installed.·They·are·usually·installed·with·the·library,·but·on·some·distros,·you·may·need·to·install·the·package·that·provides·`{namespace}-{version}.typelib`·(e.g.·`Adw-1.typelib`).\n\n###·Example\n\n```blueprint\n//·Import·libadwaita\nusing·Adw·1;\n```\n\n", |
| | 164 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-using" |
| | 165 | ····}, |
| | 166 | ····"Syntax·TranslationDomain":·{ |
| | 167 | ········"content":·"\n##·Translation·Domain\n\n```text\nTranslationDomain·=·'translation-domain'·<domain:QUOTED>·';'\n```\n\nThe·translation·domain·is·used·to·look·up·translations·for·translatable·strings·in·the·blueprint·file.·If·no·translation·domain·is·specified,·strings·will·be·looked·up·in·the·program's·global·domain.\n\nSee·[Gtk.Builder:translation-domain](https://docs.gtk.org/gtk4/property.Builder.translation-domain.html)·for·more·information.\n", |
| | 168 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/document_root.html#syntax-translationdomain" |
| | 169 | ····}, |
| | 170 | ····"Syntax·IDENT":·{ |
| | 171 | ········"content":·"\n##·IDENT\n\nAn·identifier·starts·with·an·ASCII·underscore·`_`·or·letter·`[A-Za-z]`·and·consists·of·ASCII·underscores,·letters,·digits·`[0-9]`,·and·dashes·`-`.·Dashes·are·included·for·historical·reasons,·since·GObject·properties·and·signals·are·traditionally·kebab-case.\n\n", |
| | 172 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/index.html#syntax-ident" |
| | 173 | ····}, |
| | 174 | ····"Syntax·NUMBER":·{ |
| | 175 | ········"content":·"\n##·NUMBER\n\nNumbers·begin·with·an·ASCII·digit·and·consist·of·ASCII·digits,·underscores,·dots·`.`,·and·letters·(for·radix·pre-/suffixes).·More·than·one·dot·in·a·number·is·not·allowed.·Underscores·are·permitted·for·increased·readability,·and·are·ignored.\n\nHexadecimal·numbers·may·be·specified·using·the·`0x`·prefix·and·may·use·uppercase·or·lowercase·letters,·or·a·mix.·Hexadecimal·values·may·not·have·a·fractional·part.·They·are·generally·converted·to·decimal·in·the·output.\n\n", |
| | 176 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/index.html#syntax-number" |
| | 177 | ····}, |
| | 178 | ····"Syntax·QUOTED":·{ |
| | 179 | ········"content":·"\n##·QUOTED\n\nQuotes·begin·with·an·ASCII·single·quote·`'`·or·double·quote·`\"`·and·end·with·the·same·character·they·started·with.·An·ASCII·backslash·`\\`·begins·an·escape·sequence;·this·allows·newlines·`\\n`,·tabs·`\\t`,·and·quotes·`\\'`,·`\\\"`·to·be·inserted.·It·also·allows·multiline·strings·by·escaping·a·newline·character,·which·will·be·ignored.\n", |
| | 180 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/index.html#syntax-quoted" |
| 141 | ····}, | 181 | ····}, |
| 142 | ····"Syntax·Expression":·{ | 182 | ····"Syntax·Expression":·{ |
| 143 | ········"content":·"\n##·Expressions\n\n```text\nExpression·=·(·ClosureExpression·|·Literal·|·(·'('·Expression·')'·)·)·(·LookupExpression·|·CastExpression·)*\n```\n\n####·Note\n\nThe·grammar·above·is·designed·to·eliminate·[left·recursion](https://en.wikipedia.org/wiki/Left_recursion),·which·can·make·parsing·more·complex.·In·this·format,·an·expression·consists·of·a·prefix·(such·as·a·literal·value·or·closure·invocation)·followed·by·zero·or·more·infix·or·suffix·operators.\n\nExpressions·are·composed·of·property·lookups·and/or·closures.·Property·lookups·are·the·inputs·to·the·expression,·and·closures·provided·in·application·code·can·perform·additional·calculations·on·those·inputs.\n\n\n", | 183 | ········"content":·"\n##·Expressions\n\n```text\nExpression·=·(·ClosureExpression·|·Literal·|·(·'('·Expression·')'·)·)·(·LookupExpression·|·CastExpression·)*\n```\n\n####·Note\n\nThe·grammar·above·is·designed·to·eliminate·[left·recursion](https://en.wikipedia.org/wiki/Left_recursion),·which·can·make·parsing·more·complex.·In·this·format,·an·expression·consists·of·a·prefix·(such·as·a·literal·value·or·closure·invocation)·followed·by·zero·or·more·infix·or·suffix·operators.\n\nExpressions·are·composed·of·property·lookups·and/or·closures.·Property·lookups·are·the·inputs·to·the·expression,·and·closures·provided·in·application·code·can·perform·additional·calculations·on·those·inputs.\n\n\n", |
| 144 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/expressions.html#syntax-expression" | 184 | ········"link":·"https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/reference/expressions.html#syntax-expression" |
| 145 | ····}, | 185 | ····}, |
|
Max diff block lines reached; 15982/48485 bytes (32.96%) of diff not shown.
|