wxUIntProperty Class Reference

Basic property with unsigned integer value. More...

#include <props.h>

Inheritance diagram for wxUIntProperty:

List of all members.

Public Member Functions
virtual bool	IntToValue (wxVariant &variant, int number, int argFlags=0) const
	Converts 'number' (including choice selection) into proper value 'variant'.
virtual bool	ValidateValue (wxVariant &value, wxPGValidationInfo &validationInfo) const
	Implement this function in derived class to check the value.
	wxUIntProperty (const wxString &label, const wxString &name, const wxULongLong &value)
	wxUIntProperty (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, unsigned long value=0)
Protected Attributes
wxByte	m_base
wxByte	m_prefix
wxByte	m_realBase

---

Detailed Description

Basic property with unsigned integer value.

Seamlessly supports 64-bit integer (wxULongLong) on overflow.

Supported special attributes:

• "Min", "Max": Specify acceptable value range.
• "Base": Define base. Valid constants are wxPG_BASE_OCT, wxPG_BASE_DEC, wxPG_BASE_HEX and wxPG_BASE_HEXL (lowercase characters). Arbitrary bases are not supported.
• "Prefix": Possible values are wxPG_PREFIX_NONE, wxPG_PREFIX_0x, and wxPG_PREFIX_DOLLAR_SIGN. Only wxPG_PREFIX_NONE works with Decimal and Octal numbers.

Remarks:

• For example how to use seamless 64-bit integer support, see wxIntProperty documentation (just use wxULongLong instead of wxLongLong).

---

Member Function Documentation

virtual bool wxUIntProperty::IntToValue	(	wxVariant &	value,
		int	number,
		int	argFlags = 0
	)			const [virtual]

Converts 'number' (including choice selection) into proper value 'variant'.

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

Parameters:

argFlags

If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable

Remarks:

• Default implementation may work correctly if used value type is int.
• If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
• 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.
• 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.

virtual bool wxUIntProperty::ValidateValue	(	wxVariant &	value,
		wxPGValidationInfo &	validationInfo
	)			const [virtual]

Implement this function in derived class to check the value.

Return true if it is ok. Returning false prevents property change events from occurring.

Remarks:

• Default implementation always returns true.

Reimplemented from wxPGProperty.

---

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

• props.h