Config Library: 4.4 Object Class Reference: PrefStringItemClass

Up: GEOS SDK TechDocs | Up | Prev: 4.3 PrefItemGroupClass | Next: 4.5 PrefBooleanGroupClass

Objects of this class, used together with a PrefItemGroup with its PIFF_USE_ITEM_STRINGS flag set, allow for objects which act like GenItems but can write an arbitrary string out to the .INI file if the user selects them.

Code Display 22-7 PrefStringItemClass Instance Data

@class PrefStringItemClass, GenItemClass;
@instance ChunkHandle  PSII_initFileString = 0;

MSG_PREF_STRING_ITEM_SET_INIT_FILE_STRING

void MSG_PREF_STRING_ITEM_SET_INIT_FILE_STRING(
        const char 		*str);

This message sets the string that is read and written in the .INI file.

Interception: Unlikely but possible. Default behavior sets the string and then checks again with the .INI file to make sure item should be selected.

MSG_PREF_STRING_ITEM_CHECK_IF_IN_INIT_FILE_KEY

Boolean MSG_PREF_STRING_ITEM_CHECK_IF_IN_INIT_FILE_KEY(
        PrefItemGroupStringVars 				*vars);

This message checks the passed string to see if the string bound to this item is in one of its pieces. A PrefItemGroup will send this object when loading options if it has the PIFF_USE_ITEM_STRINGS flag set.

Source: PrefItemGroup object.

Destination: PrefStringItem object.

Interception: May be intercepted if the subclass needs to check other things to decide whether it should be selected. If you also wish to have the default behavior, you may call the superclass either before or after you've made your own decision, as appropriate.

Parameters: vars Information about the string.

Return: Returns true (i.e. non-zero) if bound string is within the string stored in the local variable.


Up: GEOS SDK TechDocs | Up | Prev: 4.3 PrefItemGroupClass | Next: 4.5 PrefBooleanGroupClass