Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::ComponentSetting

VCF::ComponentSetting Class Reference

A component setting is a special "value" that may be added to a component's settings to be stored when the program shuts down, and initialized with the program starts up. More...

#include <Component.h>

Inheritance diagram for VCF::ComponentSetting:

VCF::Object List of all members.

Public Types

enum  Scope { sUser = 0, sLocal = 1 }

Public Member Functions

 ComponentSetting ()
 ComponentSetting (const String &n, const VariantData &v)
 ComponentSetting (const String &n, const String &s, const VariantData &v)
Scope getScope ()
void setScope (const Scope &val)
String getName ()
void setName (const String &val)
String getSection ()
void setSection (const String &val)
VariantData getValue ()
void setValue (const VariantData &val)

Public Attributes

Scope scope
String name
String section
VariantData value

Detailed Description

A component setting is a special "value" that may be added to a component's settings to be stored when the program shuts down, and initialized with the program starts up.

The settings stores it's value in the form of a VariantData value, which typically is some value that is mapped to a property of the component.

The setting's value has a scope that indicates whether it is stored only for the current user account, or stored on the local machine (globally). The default scope is user level. For systems that are single user only (like devices that run Windows CE), the scope is ignored.

The name of the setting is used to identify the setting's value to the component where the setting is used. Typically it is the name of a property, but it doesn't have to be. If it is not the name of a property, then a custom settings loaded method needs to be written.

Member Enumeration Documentation

enum VCF::ComponentSetting::Scope
 

Enumerator:
sUser 
sLocal 

Constructor & Destructor Documentation

VCF::ComponentSetting::ComponentSetting (   )  [inline]
 

VCF::ComponentSetting::ComponentSetting (  const String &  n,
const VariantData &  v
)  [inline]
 

VCF::ComponentSetting::ComponentSetting (  const String &  n,
const String &  s,
const VariantData &  v
)  [inline]
 

Member Function Documentation

String VCF::ComponentSetting::getName (   )  [inline]
 

Scope VCF::ComponentSetting::getScope (   )  [inline]
 

String VCF::ComponentSetting::getSection (   )  [inline]
 

VariantData VCF::ComponentSetting::getValue (   )  [inline]
 

void VCF::ComponentSetting::setName (  const String &  val  )  [inline]
 

void VCF::ComponentSetting::setScope (  const Scope &  val  )  [inline]
 

void VCF::ComponentSetting::setSection (  const String &  val  )  [inline]
 

void VCF::ComponentSetting::setValue (  const VariantData &  val  )  [inline]
 

Member Data Documentation

String VCF::ComponentSetting::name
 

Scope VCF::ComponentSetting::scope
 

String VCF::ComponentSetting::section
 

VariantData VCF::ComponentSetting::value
 

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information