Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.WindowSettingsSheet Interface Reference

Interface for sheets in WindowSettings. More...

Inheritance diagram for Dragengine.Gui.WindowSettingsSheet:
Dragengine.Gui.DefaultWindowSettingsSheet Dragengine.Gui.WSSEditBindings Dragengine.Gui.WSSModuleParameters

Public Member Functions

Widget createWidget ()
 Create widget to display sheet. More...
 
String getIdentifier ()
 Unique identifier of sheet. More...
 
String getTitle ()
 Title shown in toggle button. More...
 
void resetSettings (Widget widget)
 Reset all settings. More...
 
void saveSettings (Widget widget)
 Save all settings. More...
 

Detailed Description

Interface for sheets in WindowSettings.

This interface is used to create and manipulate the sheet content. Sheets have a unique identifier allowing to located them in the settings window. The title is used as label for the toggle button.

Member Function Documentation

◆ createWidget()

Widget Dragengine.Gui.WindowSettingsSheet.createWidget ( )

Create widget to display sheet.

Implemented in Dragengine.Gui.WSSModuleParameters, and Dragengine.Gui.WSSEditBindings.

◆ getIdentifier()

String Dragengine.Gui.WindowSettingsSheet.getIdentifier ( )

Unique identifier of sheet.

Typically used to save settings in the game configuration.

Implemented in Dragengine.Gui.DefaultWindowSettingsSheet.

◆ getTitle()

String Dragengine.Gui.WindowSettingsSheet.getTitle ( )

Title shown in toggle button.

Implemented in Dragengine.Gui.DefaultWindowSettingsSheet.

◆ resetSettings()

void Dragengine.Gui.WindowSettingsSheet.resetSettings ( Widget  widget)

Reset all settings.

Implemented in Dragengine.Gui.WSSModuleParameters, and Dragengine.Gui.WSSEditBindings.

◆ saveSettings()

void Dragengine.Gui.WindowSettingsSheet.saveSettings ( Widget  widget)

Save all settings.

Implemented in Dragengine.Gui.WSSModuleParameters, and Dragengine.Gui.WSSEditBindings.


The documentation for this interface was generated from the following file: