wxLongStringProperty Class Reference

Like wxStringProperty, but has a button that triggers a small text editor dialog. More...

#include <props.h>

Inheritance diagram for wxLongStringProperty:

List of all members.

Public Member Functions
virtual wxString	GetValueAsString (int argFlags=0) const
	Returns text representation of property's value.
virtual bool	OnButtonClick (wxPropertyGrid *propgrid, wxString &value)
virtual bool	StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
	Converts 'text' into proper value 'variant'.
	wxLongStringProperty (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxString &value=wxEmptyString)
Static Public Member Functions
static bool	DisplayEditorDialog (wxPGProperty *prop, wxPropertyGrid *propGrid, wxString &value)

---

Detailed Description

Like wxStringProperty, but has a button that triggers a small text editor dialog.

---

Member Function Documentation

virtual wxString wxLongStringProperty::GetValueAsString

(

int

argFlags = 0

)

const [virtual]

Returns text representation of property's value.

Generally this function should not be called from the application code. Instead, call GetValueString().

Parameters:

argFlags

If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wxPG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of composite property string value.

Remarks:

• Default implementation returns string composed from text representations of child properties.
• Implementations are never called with m_value being null variant (ie. unspecified value), so you don't need to check for that. Naturally this means that unspecified value is always displayed as an empty string.

See also:

GetValueString()

Reimplemented from wxPGProperty.

virtual bool wxLongStringProperty::StringToValue	(	wxVariant &	variant,
		const wxString &	text,
		int	argFlags = 0
	)			const [virtual]

Converts 'text' into proper value 'variant'.

Returns true if new (different than m_value) value could be interpreted from the text.

Parameters:

argFlags

If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by GetValueAsString() called with this same flag).

Remarks:

• Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
• 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).

Reimplemented from wxPGProperty.

---

The documentation for this class was generated from the following file:

• props.h