| Both sides previous revisionPrevious revision | |
| dragengine:modules:dragonscript:xmlguitheme:decoration [2020/04/03 10:21] – url move dragonlord | dragengine:modules:dragonscript:xmlguitheme:decoration [2024/03/14 16:44] (current) – dragonlord |
|---|
| Decorations are always based directly or indirectly on a type. This type is the //Decoration Prototype// and defines what instance of //DecorationFactory// is used in the scripts. The choice of prototype affects the appearance and functionality of the decoration and the factory configuration possibilities. | Decorations are always based directly or indirectly on a type. This type is the //Decoration Prototype// and defines what instance of //DecorationFactory// is used in the scripts. The choice of prototype affects the appearance and functionality of the decoration and the factory configuration possibilities. |
| |
| The following prototypes are provided by default by the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DecorationFactories.html|DecorationFactories]] script class: | The following prototypes are provided by default by the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DecorationFactories.html,DecorationFactories~@# script class: |
| ^ Name ^ Script Class ^ Description ^ | ^ Name ^ Script Class ^ Description ^ |
| | [[#default|Default]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DefaultDecorationFactory.html|DefaultDecorationFactory]] | Default decoration with no visual appearance and no interaction | | | [[#default|Default]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DefaultDecorationFactory.html,DefaultDecorationFactory~@# | Default decoration with no visual appearance and no interaction | |
| | [[#canvascreator|CanvasCreator]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1CanvasCreatorDecorationFactory.html|CanvasCreatorDecorationFactory]] | Decoration using canvas creator for the border elements | | | [[#canvascreator|CanvasCreator]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1CanvasCreatorDecorationFactory.html,CanvasCreatorDecorationFactory~@# | Decoration using canvas creator for the border elements | |
| |
| You can use custom prototypes by adding them to [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DecorationFactories.html|DecorationFactories]] instance before loading gui themes. This is useful if you created custom decoration subclasses requiring custom parameters. | You can use custom prototypes by adding them to #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DecorationFactories.html,DecorationFactories~@# instance before loading gui themes. This is useful if you created custom decoration subclasses requiring custom parameters. |
| |
| This example defines a decoration based on the //CanvasCreator// prototype. | This example defines a decoration based on the //CanvasCreator// prototype. |
| |
| ===== Default ===== | ===== Default ===== |
| The most basic decoration with no visual appearance and no interaction at all. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DefaultDecorationFactory.html|DefaultDecorationFactory]] script class. This is used to define windows with no decoration at all for example for full screen windows. You can also use //null// or not setting a decoration at all. By default windows have no decorations. | The most basic decoration with no visual appearance and no interaction at all. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1DefaultDecorationFactory.html,DefaultDecorationFactory~@# script class. This is used to define windows with no decoration at all for example for full screen windows. You can also use //null// or not setting a decoration at all. By default windows have no decorations. |
| |
| This factory has no parameters. | This factory has no parameters. |
| |
| ===== CanvasCreator ===== | ===== CanvasCreator ===== |
| Creates a decoration factory using canvas creators. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1CanvasCreatorDecorationFactory.html|CanvasCreatorDecorationFactory]] script class. | Creates a decoration factory using canvas creators. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1Decorations_1_1Factories_1_1CanvasCreatorDecorationFactory.html,CanvasCreatorDecorationFactory~@# script class. |
| |
| The window support these display states to style individually: | The window support these display states to style individually: |
