Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Protected Member Functions | Protected Attributes | Properties | Events | List of all members
SiliconStudio.Presentation.Settings.SettingsKey Class Referenceabstract

This class represents property to store in the settings that is identified by a key. More...

Inheritance diagram for SiliconStudio.Presentation.Settings.SettingsKey:
SiliconStudio.Presentation.Settings.SettingsListKey< T > SiliconStudio.Presentation.Settings.SettingsValueKey< T >

Protected Member Functions

 SettingsKey (UFile name, object defaultValue)
 Initializes a new instance of the SettingsKey class. More...
 

Protected Attributes

readonly object DefaultObjectValue
 The default value of the settings key. More...
 

Properties

UFile Name [get, set]
 Gets the name of this SettingsKey. More...
 
abstract Type Type [get]
 Gets the type of this SettingsKey. More...
 
bool IsEditable [get, set]
 Gets or sets whether this SettingsKey is editable by users. More...
 
UFile DisplayName [get, set]
 Gets or sets the display name of the SettingsKey. More...
 
string Description [get, set]
 Gets or sets the description of this SettingsKey. More...
 

Events

EventHandler
< ChangesValidatedEventArgs > 		ChangesValidated
 Raised when the value of the settings key has been modified and the method SettingsProfile.ValidateSettingsChanges has been invoked. More...
 

Detailed Description

This class represents property to store in the settings that is identified by a key.

Definition at line 37 of file SettingsKey.cs.

Constructor & Destructor Documentation

SiliconStudio.Presentation.Settings.SettingsKey.SettingsKey ( UFile  name,
object  defaultValue 
)
protected

Initializes a new instance of the SettingsKey class.

Parameters
nameThe name of this settings key. Must be unique amongst the application.
defaultValueThe default value associated to this settings key.

Definition at line 49 of file SettingsKey.cs.

Member Data Documentation

readonly object SiliconStudio.Presentation.Settings.SettingsKey.DefaultObjectValue
protected

The default value of the settings key.

Definition at line 42 of file SettingsKey.cs.

Property Documentation

string SiliconStudio.Presentation.Settings.SettingsKey.Description
getset

Gets or sets the description of this SettingsKey.

Definition at line 82 of file SettingsKey.cs.

UFile SiliconStudio.Presentation.Settings.SettingsKey.DisplayName
getset

Gets or sets the display name of the SettingsKey.

The default value is the name parameter given to the constructor of this class.

Definition at line 77 of file SettingsKey.cs.

bool SiliconStudio.Presentation.Settings.SettingsKey.IsEditable
getset

Gets or sets whether this SettingsKey is editable by users.

Definition at line 71 of file SettingsKey.cs.

UFile SiliconStudio.Presentation.Settings.SettingsKey.Name
getset

Gets the name of this SettingsKey.

Definition at line 61 of file SettingsKey.cs.

abstract Type SiliconStudio.Presentation.Settings.SettingsKey.Type
get

Gets the type of this SettingsKey.

Definition at line 66 of file SettingsKey.cs.

Event Documentation

EventHandler<ChangesValidatedEventArgs> SiliconStudio.Presentation.Settings.SettingsKey.ChangesValidated

Raised when the value of the settings key has been modified and the method SettingsProfile.ValidateSettingsChanges has been invoked.

Definition at line 87 of file SettingsKey.cs.

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