1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
|
\section{\class{wxPropertyValue}}\label{wxpropertyvalue}
The {\bf wxPropertyValue} class represents the value of a property,
and is normally associated with a wxProperty object.
A wxPropertyValue has one of the following types:
\begin{itemize}\itemsep=0pt
\item wxPropertyValueNull
\item wxPropertyValueInteger
\item wxPropertyValueReal
\item wxPropertyValueBool
\item wxPropertyValueString
\item wxPropertyValueList
\item wxPropertyValueIntegerPtr
\item wxPropertyValueRealPtr
\item wxPropertyValueBoolPtr
\item wxPropertyValueStringPtr
\end{itemize}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxPropertyValue::wxPropertyValue}
\func{void}{wxPropertyValue}{\void}
Default constructor.
\func{void}{wxPropertyValue}{\param{const wxPropertyValue\& }{copyFrom}}
Copy constructor.
\func{void}{wxPropertyValue}{\param{char *}{val}}
Construction from a string value.
\func{void}{wxPropertyValue}{\param{long}{ val}}
Construction from an integer value. You may need to cast to (long) to
avoid confusion with other constructors (such as the bool constructor).
\func{void}{wxPropertyValue}{\param{bool}{ val}}
Construction from a boolean value.
\func{void}{wxPropertyValue}{\param{float}{ val}}
Construction from a floating point value.
\func{void}{wxPropertyValue}{\param{double}{ val}}
Construction from a floating point value.
\func{void}{wxPropertyValue}{\param{wxList *}{ val}}
Construction from a list of wxPropertyValue objects. The
list, but not each contained wxPropertyValue, will be deleted
by the constructor. The wxPropertyValues will be assigned to
this wxPropertyValue list. In other words, so do not delete wxList or
its data after calling this constructor.
\func{void}{wxPropertyValue}{\param{wxStringList *}{ val}}
Construction from a list of strings. The list (including the strings
contained in it) will be deleted by the constructor, so do not
destroy {\it val} explicitly.
\func{void}{wxPropertyValue}{\param{char **}{val}}
Construction from a string pointer.
\func{void}{wxPropertyValue}{\param{long *}{val}}
Construction from an integer pointer.
\func{void}{wxPropertyValue}{\param{bool *}{val}}
Construction from an boolean pointer.
\func{void}{wxPropertyValue}{\param{float *}{val}}
Construction from a floating point pointer.
The last four constructors use pointers to various C++ types, and do not
store the types themselves; this allows the values to stand in for actual
data values defined elsewhere.
\membersection{wxPropertyValue::\destruct{wxPropertyValue}}
\func{void}{\destruct{wxPropertyValue}}{\void}
Destructor.
\membersection{wxPropertyValue::Append}
\func{void}{Append}{\param{wxPropertyValue *}{expr}}
Appends a property value to the list.
\membersection{wxPropertyValue::BoolValue}
\func{bool}{BoolValue}{\void}
Returns the boolean value.
\membersection{wxPropertyValue::BoolValuePtr}
\func{bool *}{BoolValuePtr}{\void}
Returns the pointer to the boolean value.
\membersection{wxPropertyValue::ClearList}
\func{void}{ClearList}{\void}
Deletes the contents of the list.
\membersection{wxPropertyValue::Delete}
\func{void}{Delete}{\param{wxPropertyValue *}{expr}}
Deletes {\it expr} from this list.
\membersection{wxPropertyValue::GetFirst}
\func{wxPropertyValue *}{GetFirst}{\void}
Gets the first value in the list.
\membersection{wxPropertyValue::GetLast}
\func{wxPropertyValue *}{GetFirst}{\void}
Gets the last value in the list.
\membersection{wxPropertyValue::GetModified}
\func{bool}{GetModified}{\void}
Returns true if the value was modified since being created
(or since SetModified was called).
\membersection{wxPropertyValue::GetNext}
\func{wxPropertyValue *}{GetNext}{\void}
Gets the next value in the list (the one after `this').
\membersection{wxPropertyValue::GetStringRepresentation}
\func{wxString}{GetStringRepresentation}{\void}
Gets a string representation of the value.
\membersection{wxPropertyValue::IntegerValue}
\func{long}{IntegerValue}{\void}
Returns the integer value.
\membersection{wxPropertyValue::Insert}
\func{void}{Insert}{\param{wxPropertyValue *}{expr}}
Inserts a property value at the front of a list.
\membersection{wxPropertyValue::IntegerValuePtr}
\func{long *}{IntegerValuePtr}{\void}
Returns the pointer to the integer value.
\membersection{wxPropertyValue::Nth}
\func{wxPropertyValue *}{Nth}{\param{int}{ n}}
Returns the nth value of a list expression (starting from zero).
\membersection{wxPropertyValue::Number}
\func{int}{Number}{\void}
Returns the number of elements in a list expression.
\membersection{wxPropertyValue::RealValue}
\func{float}{RealValue}{\void}
Returns the floating point value.
\membersection{wxPropertyValue::RealValuePtr}
\func{float *}{RealValuePtr}{\void}
Returns the pointer to the floating point value.
\membersection{wxPropertyValue::SetModified}
\func{void}{SetModified}{\param{bool}{ flag}}
Sets the `modified' flag.
\membersection{wxPropertyValue::StringValue}
\func{char *}{StringValue}{\void}
Returns the string value.
\membersection{wxPropertyValue::StringValuePtr}
\func{char **}{StringValuePtr}{\void}
Returns the pointer to the string value.
\membersection{wxPropertyValue::Type}
\func{wxPropertyValueType}{Type}{\void}
Returns the value type.
\membersection{wxPropertyValue::operator $=$}
\func{void}{operator $=$}{\param{const wxPropertyValue\& }{val}}
\func{void}{operator $=$}{\param{const char *}{val}}
\func{void}{operator $=$}{\param{const long }{val}}
\func{void}{operator $=$}{\param{const bool }{val}}
\func{void}{operator $=$}{\param{const float }{val}}
\func{void}{operator $=$}{\param{const char **}{val}}
\func{void}{operator $=$}{\param{const long *}{val}}
\func{void}{operator $=$}{\param{const bool *}{val}}
\func{void}{operator $=$}{\param{const float *}{val}}
Assignment operators.
|