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