wxMultiChoiceProperty Class Reference

Property that manages a value resulting from wxMultiChoiceDialog. More...

#include <advprops.h>

Inheritance diagram for wxMultiChoiceProperty:

List of all members.

Public Member Functions
virtual int	GetChoiceInfo (wxPGChoiceInfo *choiceinfo)
	Returns current value's index to the choice control.
wxArrayInt	GetValueAsArrayInt () const
virtual wxString	GetValueAsString (int flags=0) const
	Returns text representation of property's value.
virtual bool	OnEvent (wxPropertyGrid *propgrid, wxWindow *primary, wxEvent &event)
	Events received by editor widgets are processed here.
virtual void	OnSetValue ()
	This virtual function is called after m_value has been set.
virtual bool	StringToValue (wxVariant &variant, const wxString &text, int argFlags=0) const
	Converts 'text' into proper value 'variant'.
	wxMultiChoiceProperty (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxArrayString &value=wxArrayString())
	wxMultiChoiceProperty (const wxString &label, const wxString &name, const wxPGChoices &choices, const wxArrayString &value=wxArrayString())
	wxMultiChoiceProperty (const wxString &label, const wxString &name, const wxArrayString &strings, const wxArrayString &value)
Protected Member Functions
void	GenerateValueAsString ()
wxArrayInt	GetValueAsIndices () const
Protected Attributes
wxPGChoices	m_choices
wxString	m_display
wxArrayString	m_valueAsStrings

---

Detailed Description

Property that manages a value resulting from wxMultiChoiceDialog.

Value is array of strings. You can get value as array of choice values/indices by calling wxMultiChoiceProperty::GetValueAsArrayInt().

Supported special attributes:

• "UserStringMode": If > 0, allow user to manually enter strings that are not in the list of choices. If this value is 1, user strings are preferably placed in front of valid choices. If value is 2, then those strings will placed behind valid choices.

---

Member Function Documentation

virtual int wxMultiChoiceProperty::GetChoiceInfo

(

wxPGChoiceInfo *

choiceinfo

)

[virtual]

Returns current value's index to the choice control.

May also return, through pointer arguments, strings that should be inserted to that control. Irrelevant to classes which do not employ wxPG_EDITOR(Choice) or similar.

Remarks:

• If returns NULL in choices, then this class must be derived from wxBaseEnumProperty.
• Must not crash even if property's set of choices is uninitialized (i.e. it points to wxPGGlobalVars->m_emptyConstants).

Reimplemented from wxPGProperty.

virtual wxString wxMultiChoiceProperty::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 wxMultiChoiceProperty::OnEvent	(	wxPropertyGrid *	propgrid,
		wxWindow *	wnd_primary,
		wxEvent &	event
	)			[virtual]

Events received by editor widgets are processed here.

Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, should be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, wxSystemColourProperty custom handles wxEVT_COMMAND_CHOICE_SELECTED).

If the event causes value to be changed, wxPropertyGrid::ValueChangeInEvent(value) should be used.

Parameters:

event

Associated wxEvent.

Return values:

Should

return true if any changes in value should be reported.

Remarks:

• If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.

Reimplemented from wxPGProperty.

virtual void wxMultiChoiceProperty::OnSetValue

(

)

[virtual]

This virtual function is called after m_value has been set.

Remarks:

• If m_value was set to Null variant (ie. unspecified value), OnSetValue() will not be called.
• m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue() provides a good opportunity to convert supported values into internal type.
• Default implementation does nothing.

Reimplemented from wxPGProperty.

virtual bool wxMultiChoiceProperty::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:

• advprops.h