MGunit documentation

Unit testing for IDL

single page | use frames     summary     class     fields     routine details     file attributes

dist_tools/

mgffprefs__define.pro

includes main-level program

Class responsible for storing and retrieving preferences. Preferences are persistent across IDL sessions on the same computer.

Class description for mgffprefs

Properties

author_name init

short name of the author

app_name init

short name of the application

app_description init

full name of the application

author_description init

full name of the author

app_directory get

location of the directory for the application using these preferences

Fields

appdir ''

directory to place preference files

Routines

mgffprefs::set, prefname, prefvalue

Save the value of a preference.

result = mgffprefs::get(prefname [, /found] [, default=any] [, /names])

Retrieve the value of a preference.

result = mgffprefs::_prefnameToFilename(prefname)

Converts a preference name to a valid save filename.

result = mgffprefs::_getAppDir(authorName, appName [, author_description=string] [, app_description=string])

Returns directory for application data.

mgffprefs::getProperty, app_directory=app_directory

Get properties.

mgffprefs::cleanup

Free resources.

result = mgffprefs::init(author_name=string, app_name=string [, author_description=string] [, app_description=string])

Initialize a prefs object.

mgffprefs__define

Define instance variables.

Routine details

topmgffprefs::set

mgffprefs::set, prefname, prefvalue

Save the value of a preference.

Parameters

prefname in required type=string

case-insensitive name of preference to retrieve

prefvalue in required type=any

value of the preference

topmgffprefs::get

result = mgffprefs::get(prefname [, /found] [, default=any] [, /names])

Retrieve the value of a preference.

Return value

preference value

Parameters

prefname in required type=string

case-insensitive name of preference to retrieve

Keywords

found out optional type=boolean

set to a named variable to return whether the preference was found

default in optional type=any

default value to use if no preference value is found for the given preference name

names in optional type=boolean

set to return a list of the preference names instead of a value; names may not agree exactly with the names given in the set method because they have been modified to make valid filename

topmgffprefs::_prefnameToFilename

result = mgffprefs::_prefnameToFilename(prefname)

Converts a preference name to a valid save filename.

Return value

string

Parameters

prefname in required type=string

name of preference

topmgffprefs::_getAppDir

result = mgffprefs::_getAppDir(authorName, appName [, author_description=string] [, app_description=string])

Returns directory for application data.

Return value

string

Parameters

authorName in required type=string

short name of the author

appName in required type=string

short application name

Keywords

author_description in optional type=string

full name of the author

app_description in optional type=string

full name of the application

topmgffprefs::getProperty

mgffprefs::getProperty, app_directory=app_directory

Get properties.

Keywords

app_directory

location of the directory for the application using these preferences

topmgffprefs::cleanup

mgffprefs::cleanup

Free resources.

topmgffprefs::init

result = mgffprefs::init(author_name=string, app_name=string [, author_description=string] [, app_description=string])

Initialize a prefs object.

Return value

1 for success, 0 for failure

Keywords

author_name in required type=string

short name of the author

app_name in required type=string

short name of the application

author_description in optional type=string

full name of the author

app_description in optional type=string

full name of the application

topmgffprefs__define

mgffprefs__define

Define instance variables.

File attributes

Modification date: Wed Apr 22 23:29:01 2009
Lines: 235
Docformat: rst rst