wxFontProperty Class Reference

Property representing wxFont. More...

#include <advprops.h>

Inheritance diagram for wxFontProperty:
wxPGProperty

List of all members.

Public Member Functions

virtual wxString GetValueAsString (int argFlags=0) const
 Returns text representation of property's value.
virtual void OnSetValue ()
 This virtual function is called after m_value has been set.
 wxFontProperty (const wxString &label=wxPG_LABEL, const wxString &name=wxPG_LABEL, const wxFont &value=wxFont())

Detailed Description

Property representing wxFont.


Member Function Documentation

virtual wxString wxFontProperty::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 void wxFontProperty::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.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator

Generated on 28 Jan 2012 for wxPropertyGrid by  doxygen 1.6.1