projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 200fed6c VS |
1 | \section{\class{wxPropertySheet}}\label{wxpropertysheet} |
| 2 | ||
| 200fed6c VS |
3 | The {\bf wxPropertySheet} class is used for storing a number of |
| 4 | wxProperty objects (essentially names and values). | |
| 5 | ||
| fa482912 JS |
6 | \wxheading{See also} |
| 7 | ||
| 8 | \helpref{wxPropertySheet overview}{wxpropertysheetoverview} | |
| 9 | ||
| 10 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 11 | ||
| 200fed6c VS |
12 | \membersection{wxPropertySheet::wxPropertySheet} |
| 13 | ||
| 14 | \func{void}{wxPropertySheet}{\param{const wxString}{ name = ""}} | |
| 15 | ||
| 16 | Constructor. Sets property sheet's name to name if present. | |
| 17 | ||
| 18 | \membersection{wxPropertySheet::\destruct{wxPropertySheet}} | |
| 19 | ||
| 20 | \func{void}{\destruct{wxPropertySheet}}{\void} | |
| 21 | ||
| 22 | Destructor. Destroys all contained properties. | |
| 23 | ||
| 24 | \membersection{wxPropertySheet::AddProperty}\label{wxpropertysheetaddproperty} | |
| 25 | ||
| 26 | \func{void}{AddProperty}{\param{wxProperty *}{property}} | |
| 27 | ||
| 28 | Adds a property to the sheet. | |
| 29 | ||
| 30 | \membersection{wxPropertySheet::Clear}\label{wxpropertysheetclear} | |
| 31 | ||
| 32 | \func{void}{Clear}{\void} | |
| 33 | ||
| 34 | Clears all the properties from the sheet (deleting them). | |
| 35 | ||
| 36 | \membersection{wxPropertySheet::GetName}\label{wxpropertysheetgetname} | |
| 37 | ||
| 38 | \func{wxString}{GetName}{\void} | |
| 39 | ||
| 40 | Gets the sheet's name. | |
| 41 | ||
| 42 | \membersection{wxPropertySheet::GetProperty}\label{wxpropertysheetgetproperty} | |
| 43 | ||
| 44 | \func{wxProperty *}{GetProperty}{\param{wxString}{ name}} | |
| 45 | ||
| 46 | Gets a property by name. | |
| 47 | ||
| 48 | \membersection{wxPropertySheet::GetProperties}\label{wxpropertysheetgetproperties} | |
| 49 | ||
| 50 | \func{wxList\&}{GetProperties}{\void} | |
| 51 | ||
| 52 | Returns a reference to the internal list of properties. | |
| 53 | ||
| 54 | \membersection{wxPropertySheet::HasProperty}\label{wxpropertysheethasproperty} | |
| 55 | ||
| 56 | \func{bool}{HasProperty}{\param{wxString}{ propname}} | |
| 57 | ||
| 58 | Returns true if sheet contains property propname. | |
| 59 | ||
| 60 | \membersection{wxPropertySheet::RemoveProperty}\label{wxpropertysheetremoveproperty} | |
| 61 | ||
| 62 | \func{void}{RemoveProperty}{\param{wxString}{ propname}} | |
| 63 | ||
| 64 | Removes property propname from sheet, deleting it. | |
| 65 | ||
| 66 | \membersection{wxPropertySheet::SetName}\label{wxpropertysheetsetname} | |
| 67 | ||
| 68 | \func{void}{SetName}{\param{wxString}{ sheetname}} | |
| 69 | ||
| 70 | Set the sheet's name to sheetname | |
| 71 | ||
| 72 | \membersection{wxPropertySheet::SetProperty}\label{wxpropertysheetsetproperty} | |
| 73 | ||
| 74 | \func{bool}{SetProperty}{\param{wxString}{ propname}, \param{wxPropertyValue}{ value}} | |
| 75 | ||
| 76 | Sets property propname to value. Returns false if property is not a member of sheet. | |
| 77 | ||
| 78 | \membersection{wxPropertySheet::SetAllModified} | |
| 79 | ||
| fa482912 | 80 | \func{void}{SetAllModified}{\param{bool}{ flag}} |
| 200fed6c VS |
81 | |
| 82 | Sets the `modified' flag of each property value. | |
| 83 |