docs/latex/wx/propval.tex

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