Modern IDL by Michael Galloy

API documentation for example code

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

objects/

mgffprefs__define.pro


Class responsible for storing and retrieving preferences.

Class description for mgffprefs

Properties

Properties in mgffprefs

app_description init

full name of the application

app_directory get

location of the directory for the application using these preferences

app_name init

short name of the application

author_description init

full name of the author

author_name init

short name of the author

Fields

Fields in mgffprefs

appdir ''

directory to place preference files

Routines

Routines from mgffprefs__define.pro

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::_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

top source mgffprefs::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

top source mgffprefs::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

top source mgffprefs::_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

top source mgffprefs::getProperty

mgffprefs::getProperty, app_directory=app_directory

Get properties.

Keywords

app_directory

location of the directory for the application using these preferences

top source mgffprefs::cleanup

mgffprefs::cleanup

Free resources.

top source mgffprefs::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

top source mgffprefs__define

mgffprefs__define

Define instance variables.

File attributes

Modification date: Mon Apr 6 21:46:59 2009
Lines: 70
Docformat: rst rst