/////////////////////////////////////////////////////////////////////////////
// Name: sysopt.h
-// Purpose: documentation for wxSystemOptions class
+// Purpose: interface of wxSystemOptions
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{misc}
- @seealso
- wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
+ @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
wxSystemOptions::HasOption
*/
class wxSystemOptions : public wxObject
/**
Gets an option. The function is case-insensitive to @e name.
-
Returns empty string if the option hasn't been set.
- @sa SetOption(), GetOptionInt(),
- HasOption()
+ @see SetOption(), GetOptionInt(),
+ HasOption()
*/
- wxString GetOption(const wxString& name);
+ wxString GetOption(const wxString& name) const;
/**
Gets an option as an integer. The function is case-insensitive to @e name.
-
If the option hasn't been set, this function returns 0.
- @sa SetOption(), GetOption(),
- HasOption()
+ @see SetOption(), GetOption(),
+ HasOption()
*/
- int GetOptionInt(const wxString& name);
+ int GetOptionInt(const wxString& name) const;
/**
Returns @true if the given option is present. The function is
case-insensitive to @e name.
- @sa SetOption(), GetOption(),
- GetOptionInt()
+ @see SetOption(), GetOption(),
+ GetOptionInt()
*/
- bool HasOption(const wxString& name);
+ bool HasOption(const wxString& name) const;
/**
- Returns @true if the option with the given @e name had been set to 0
+ Returns @true if the option with the given @a name had been set to 0
value. This is mostly useful for boolean options for which you can't use
@c GetOptionInt(name) == 0 as this would also be @true if the option
hadn't been set at all.
*/
- bool IsFalse(const wxString& name);
+ bool IsFalse(const wxString& name) const;
//@{
/**
void SetOption(const wxString& name, int value);
//@}
};
+