iAwsPrefManager Struct Reference
[AWS]
Interface for the preferences manager (window manager needs one.).
More...
#include <iaws/aws.h>
Inheritance diagram for iAwsPrefManager:

Public Member Functions | |
virtual bool | Setup (iObjectRegistry *object_reg)=0 |
Performs whatever initialization is needed. | |
virtual bool | Load (const char *def_file)=0 |
Invokes the definition parser to load definition files. | |
virtual unsigned long | NameToId (const char *name)=0 |
Maps a name to an id. | |
virtual bool | SelectDefaultSkin (const char *skin_name)=0 |
Select which skin is the default for components, the skin must be loaded. | |
virtual bool | LookupIntKey (const char *name, int &val)=0 |
Lookup the value of an int key by name (from the skin def). | |
virtual bool | LookupIntKey (unsigned long id, int &val)=0 |
Lookup the value of an int key by id (from the skin def). | |
virtual bool | LookupStringKey (const char *name, iString *&val)=0 |
Lookup the value of a string key by name (from the skin def). | |
virtual bool | LookupStringKey (unsigned long id, iString *&val)=0 |
Lookup the value of a string key by id (from the skin def). | |
virtual bool | LookupRectKey (const char *name, csRect &rect)=0 |
Lookup the value of a rect key by name (from the skin def). | |
virtual bool | LookupRectKey (unsigned long id, csRect &rect)=0 |
Lookup the value of a rect key by id (from the skin def). | |
virtual bool | LookupRGBKey (const char *name, unsigned char &red, unsigned char &green, unsigned char &blue)=0 |
Lookup the value of an RGB key by name (from the skin def). | |
virtual bool | LookupRGBKey (unsigned long id, unsigned char &red, unsigned char &green, unsigned char &blue)=0 |
Lookup the value of an RGB key by name (from the skin def). | |
virtual bool | LookupPointKey (const char *name, csPoint &point)=0 |
Lookup the value of a point key by name (from the skin def). | |
virtual bool | LookupPointKey (unsigned long id, csPoint &point)=0 |
Lookup the value of a point key by id (from the skin def). | |
virtual bool | GetInt (iAwsComponentNode *node, const char *name, int &val)=0 |
Get the an integer from a given component node. | |
virtual bool | GetFloat (iAwsComponentNode *, const char *name, float &val)=0 |
Get the float value from a given component node. | |
virtual bool | GetRect (iAwsComponentNode *node, const char *name, csRect &rect)=0 |
Get the a rect from a given component node. | |
virtual bool | GetString (iAwsComponentNode *node, const char *name, iString *&val)=0 |
Get the value of an integer from a given component node. | |
virtual bool | GetRGB (iAwsComponentNode *node, const char *name, unsigned char &r, unsigned char &g, unsigned char &b)=0 |
Get the a color from a given component node. | |
virtual iAwsComponentNode * | FindWindowDef (const char *name)=0 |
Find window definition and return the component node holding it, Null otherwise. | |
virtual iAwsKeyContainer * | FindSkinDef (const char *name)=0 |
Find skin def and return key container, Null if not found. | |
virtual bool | RemoveWindowDef (const char *name)=0 |
Completely remove a window definition (return false if not found). | |
virtual void | RemoveAllWindowDefs ()=0 |
Remove all window definitions. | |
virtual bool | RemoveSkinDef (const char *name)=0 |
Completely remove a skin definition (return false if not found). | |
virtual void | RemoveAllSkinDefs ()=0 |
Remove all skin definitions. | |
virtual void | SetColor (int index, int color)=0 |
Sets the value of a color in the global AWS palette. | |
virtual int | GetColor (int index)=0 |
Gets the value of a color from the global AWS palette. | |
virtual int | FindColor (unsigned char r, unsigned char g, unsigned char b)=0 |
Finds the closest matching color. | |
virtual iFont * | GetDefaultFont ()=0 |
Gets the current default font. | |
virtual iFont * | GetFont (const char *filename)=0 |
Gets a font. If it's not loaded, it will be. Returns 0 on error. | |
virtual iTextureHandle * | GetTexture (const char *name, const char *filename=0)=0 |
Gets a texture from the global AWS cache. | |
virtual iTextureHandle * | GetTexture (const char *name, const char *filename, unsigned char key_r, unsigned char key_g, unsigned char key_b)=0 |
Gets a texture from the global AWS cache, if its loaded for the first time then the keycolor (key_r,key_g,key_b) is set. | |
virtual void | SetTextureManager (iTextureManager *txtmgr)=0 |
Sets the texture manager that the preference manager uses. | |
virtual void | SetFontServer (iFontServer *fntsvr)=0 |
Sets the font server that the preference manager uses. | |
virtual void | SetDefaultFont (iFont *font)=0 |
Set the default font that the preference manager uses. | |
virtual void | SetWindowMgr (iAws *wmgr)=0 |
Sets the window manager that the preference manager uses. | |
virtual void | SetupPalette ()=0 |
Sets up the AWS palette so that the colors are valid reflections of user preferences. | |
virtual void | RegisterConstant (const char *name, int value)=0 |
Allows a component to specify it's own constant values for parsing. | |
virtual bool | ConstantExists (const char *name)=0 |
Returns true if the constant has been registered, false otherwise. | |
virtual int | GetConstantValue (const char *name)=0 |
Allows a component to retrieve the value of a constant, or the parser as well. | |
virtual iAwsKeyFactory * | CreateKeyFactory ()=0 |
Creates a new key factory. | |
virtual iAwsConnectionNodeFactory * | CreateConnectionNodeFactory ()=0 |
Creates a new connection node factory. |
Detailed Description
Interface for the preferences manager (window manager needs one.).
Definition at line 430 of file aws.h.
Member Function Documentation
|
Returns true if the constant has been registered, false otherwise.
|
|
Creates a new connection node factory.
|
|
Creates a new key factory.
|
|
Finds the closest matching color.
|
|
Find skin def and return key container, Null if not found.
|
|
Find window definition and return the component node holding it, Null otherwise.
|
|
Gets the value of a color from the global AWS palette.
|
|
Allows a component to retrieve the value of a constant, or the parser as well.
|
|
Gets the current default font.
|
|
Get the float value from a given component node.
|
|
Gets a font. If it's not loaded, it will be. Returns 0 on error.
|
|
Get the an integer from a given component node.
|
|
Get the a rect from a given component node.
|
|
Get the a color from a given component node.
|
|
Get the value of an integer from a given component node.
|
|
Gets a texture from the global AWS cache, if its loaded for the first time then the keycolor (key_r,key_g,key_b) is set.
|
|
Gets a texture from the global AWS cache.
|
|
Invokes the definition parser to load definition files.
|
|
Lookup the value of an int key by id (from the skin def).
|
|
Lookup the value of an int key by name (from the skin def).
|
|
Lookup the value of a point key by id (from the skin def).
|
|
Lookup the value of a point key by name (from the skin def).
|
|
Lookup the value of a rect key by id (from the skin def).
|
|
Lookup the value of a rect key by name (from the skin def).
|
|
Lookup the value of an RGB key by name (from the skin def).
|
|
Lookup the value of an RGB key by name (from the skin def).
|
|
Lookup the value of a string key by id (from the skin def).
|
|
Lookup the value of a string key by name (from the skin def).
|
|
Maps a name to an id.
|
|
Allows a component to specify it's own constant values for parsing.
Referenced by awsEmbeddedComponentFactory::RegisterConstant(). |
|
Remove all skin definitions.
|
|
Remove all window definitions.
|
|
Completely remove a skin definition (return false if not found).
|
|
Completely remove a window definition (return false if not found).
|
|
Select which skin is the default for components, the skin must be loaded. True on success, false otherwise. |
|
Sets the value of a color in the global AWS palette.
|
|
Set the default font that the preference manager uses.
|
|
Sets the font server that the preference manager uses.
|
|
Sets the texture manager that the preference manager uses.
|
|
Performs whatever initialization is needed.
|
|
Sets up the AWS palette so that the colors are valid reflections of user preferences. Although SetColor can be used, it's recommended that you do not. Colors should always be a user preference, and should be read from the window and skin definition files (as happens automatically normally. |
|
Sets the window manager that the preference manager uses.
|
The documentation for this struct was generated from the following file:
- iaws/aws.h
Generated for Crystal Space by doxygen 1.3.9.1