*/
#define wxPG_FILE_DIALOG_TITLE wxS("DialogTitle")
+/** Specific to wxFileProperty and derivatives, long, default is 0.
+ Sets a specific wxFileDialog style for the file dialog, e.g. ::wxFD_SAVE.
+
+ @since 2.9.4
+*/
+#define wxPG_FILE_DIALOG_STYLE wxS("DialogStyle")
+
/** Specific to wxDirProperty, wxString, default is empty.
Sets a specific message for the dir dialog.
*/
#define wxPG_DIR_DIALOG_MESSAGE wxS("DialogMessage")
/**
- wxArrayStringProperty's string delimiter character. If this is aquotation
+ wxArrayStringProperty's string delimiter character. If this is a quotation
mark or hyphen, then strings will be quoted instead (with given
character).
#define wxPG_DATE_PICKER_STYLE wxS("PickerStyle")
/** SpinCtrl editor, int or double. How much number changes when button is
- pressed (or up/down on keybard).
+ pressed (or up/down on keyboard).
*/
#define wxPG_ATTR_SPINCTRL_STEP wxS("Step")
If property is selected, then indicates that validation failed for pending
value.
- If property is not selected, then indicates that the the actual property
- value has failed validation (NB: this behavior is not currently supported,
- but may be used in future).
+ If property is not selected, then indicates that the actual property
+ value has failed validation (NB: this behaviour is not currently supported,
+ but may be used in the future).
*/
wxPG_PROP_INVALID_VALUE = 0x0040,
Note that when displaying the value, sign is omitted if the resulting
textual representation is effectively zero (for example, -0.0001 with
- precision of 3 will become 0.0 instead of -0.0). This behavior is unlike
+ precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike
what C standard library does, but should result in better end-user
experience in almost all cases.
@subsection wxBoolProperty
Represents a boolean value. wxChoice is used as editor control, by the
- default. wxPG_BOOL_USE_CHECKBOX attribute can be set to true inorder to use
- check box instead.
+ default. wxPG_BOOL_USE_CHECKBOX attribute can be set to true in order to
+ use check box instead.
@subsection wxLongStringProperty
Like wxLongStringProperty, but the button triggers file selector instead.
Default wildcard is "All files..." but this can be changed by setting
wxPG_FILE_WILDCARD attribute (see wxFileDialog for format details).
- Attribute wxPG_FILE_SHOW_FULL_PATH can be set to @false inorder to show
+ Attribute wxPG_FILE_SHOW_FULL_PATH can be set to @false in order to show
only the filename, not the entire path.
@subsection wxEnumProperty
Represents a bit set that fits in a long integer. wxBoolProperty sub-
properties are created for editing individual bits. Textctrl is created to
- manually edit the flags as a text; a continous sequence of spaces, commas
+ manually edit the flags as a text; a continuous sequence of spaces, commas
and semicolons are considered as a flag id separator.
<b>Note:</b> When changing "choices" (ie. flag labels) of wxFlagsProperty,
@subsection wxDateProperty
- wxDateTime property. Default editor is DatePickerCtrl, altough TextCtrl
+ wxDateTime property. Default editor is DatePickerCtrl, although TextCtrl
should work as well. wxPG_DATE_FORMAT attribute can be used to change
- string wxDateTime::Format uses (altough default is recommended as it is
- locale-dependant), and wxPG_DATE_PICKER_STYLE allows changing window
+ string wxDateTime::Format uses (although default is recommended as it is
+ locale-dependent), and wxPG_DATE_PICKER_STYLE allows changing window
style given to DatePickerCtrl (default is wxDP_DEFAULT|wxDP_SHOWCENTURY).
Using wxDP_ALLOWNONE will enable better unspecified value support.
@endcode
in wxSystemColourProperty, and its derived class wxColourProperty, there
- are various sub-classing features. To set basic list list of colour
+ are various sub-classing features. To set a basic list of colour
names, call wxPGProperty::SetChoices().
@code
You might want to take into account that m_value is Null variant
if property value is unspecified (which is usually only case if
- you explicitly enabled that sort behavior).
+ you explicitly enabled that sort behaviour).
*/
virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const;
instead of OnEvent.
- You might want to take into account that m_value is Mull variant if
property value is unspecified (which is usually only case if you
- explicitly enabled that sort behavior).
+ explicitly enabled that sort behaviour).
*/
virtual bool IntToValue( wxVariant& variant, int number, int argFlags = 0 ) const;
/**
Converts string to a value, and if successful, calls SetValue() on it.
- Default behavior is to do nothing.
+ Default behaviour is to do nothing.
@param text
String to get the value from.
bool SetValueFromString( const wxString& text, int flags = 0 );
/**
- Converts integer to a value, and if succesful, calls SetValue() on it.
- Default behavior is to do nothing.
+ Converts integer to a value, and if successful, calls SetValue() on it.
+ Default behaviour is to do nothing.
@param value
Int to get the value from.
Normally -1, but can be an index to the property's list of items.
@remarks
- - Default behavior is to return wxSize(0,0), which means no image.
+ - Default behaviour is to return wxSize(0,0), which means no image.
- Default image width or height is indicated with dimension -1.
- You can also return wxPG_DEFAULT_IMAGE_SIZE which equals wxSize(-1, -1).
*/
/**
Called after value of a child property has been altered. Must return
- new value of the whole property (after any alterations warrented by
+ new value of the whole property (after any alterations warranted by
child's new value).
Note that this function is usually called at the time that value of
*/
void DeleteChoice( int index );
- /** Deletes all child properties. */
- void Empty();
-
/**
Enables or disables the property. Disabled property usually appears
as having grey text.
/**
Returns true if property has editable wxTextCtrl when selected.
- @remarks Altough disabled properties do not displayed editor, they still
+ @remarks Although disabled properties do not displayed editor, they still
return @true here as being disabled is considered a temporary
condition (unlike being read-only or having limited editing enabled).
*/
wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty.
@param enable
- Whether to enable or disable this behavior (it is disabled by
+ Whether to enable or disable this behaviour (it is disabled by
default).
*/
void SetAutoUnspecified( bool enable = true );
Returns @true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
*/
bool UsesAutoUnspecified() const;
+
+protected:
+ /** Deletes all child properties. */
+ void Empty();
};
*/
void Add( const wxChar** labels, const ValArrItem* values = NULL );
- /** Version that works with wxArrayString. */
- void Add( const wxArrayString& arr, const ValArrItem* values = NULL );
-
/** Version that works with wxArrayString and wxArrayInt. */
void Add( const wxArrayString& arr, const wxArrayInt& arrint );
wxPGChoices Copy() const;
/**
- Returns labe of item.
+ Returns label of item.
*/
const wxString& GetLabel( unsigned int ind ) const;
wxArrayInt GetIndicesForStrings( const wxArrayString& strings,
wxArrayString* unmatched = NULL ) const;
- /** Returns property at given virtual y coordinate.
- */
- wxPGProperty* GetItemAtY( unsigned int y ) const;
-
- /**
- Returns @true if item at given index has a valid value;
- */
- bool HasValue( unsigned int i ) const;
-
/**
Returns index of item with given label.
*/
projects / wxWidgets.git / blobdiff