Version: 3.0.4
wxPGCell Class Reference

#include <wx/propgrid/property.h>

+ Inheritance diagram for wxPGCell:

Detailed Description

Base class for wxPropertyGrid cell information.

Library:  wxPropertyGrid
Category:  wxPropertyGrid

Public Member Functions

 wxPGCell ()
 
 wxPGCell (const wxPGCell &other)
 
 wxPGCell (const wxString &text, const wxBitmap &bitmap=wxNullBitmap, const wxColour &fgCol=wxNullColour, const wxColour &bgCol=wxNullColour)
 
virtual ~wxPGCell ()
 
const wxPGCellDataGetData () const
 
bool HasText () const
 Returns true if this cell has custom text stored within. More...
 
void MergeFrom (const wxPGCell &srcCell)
 Merges valid data from srcCell into this. More...
 
void SetText (const wxString &text)
 
void SetBitmap (const wxBitmap &bitmap)
 
void SetFgCol (const wxColour &col)
 
void SetFont (const wxFont &font)
 Sets font of the cell. More...
 
void SetBgCol (const wxColour &col)
 
const wxStringGetText () const
 
const wxBitmapGetBitmap () const
 
const wxColourGetFgCol () const
 
const wxFontGetFont () const
 Returns font of the cell. More...
 
const wxColourGetBgCol () const
 
wxPGCelloperator= (const wxPGCell &other)
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxPGCell::wxPGCell ( )
wxPGCell::wxPGCell ( const wxPGCell other)
wxPGCell::wxPGCell ( const wxString text,
const wxBitmap bitmap = wxNullBitmap,
const wxColour fgCol = wxNullColour,
const wxColour bgCol = wxNullColour 
)
virtual wxPGCell::~wxPGCell ( )
virtual

Member Function Documentation

const wxColour& wxPGCell::GetBgCol ( ) const
const wxBitmap& wxPGCell::GetBitmap ( ) const
const wxPGCellData* wxPGCell::GetData ( ) const
const wxColour& wxPGCell::GetFgCol ( ) const
const wxFont& wxPGCell::GetFont ( ) const

Returns font of the cell.

If no specific font is set for this cell, then the font will be invalid.

const wxString& wxPGCell::GetText ( ) const
bool wxPGCell::HasText ( ) const

Returns true if this cell has custom text stored within.

void wxPGCell::MergeFrom ( const wxPGCell srcCell)

Merges valid data from srcCell into this.

wxPGCell& wxPGCell::operator= ( const wxPGCell other)
void wxPGCell::SetBgCol ( const wxColour col)
void wxPGCell::SetBitmap ( const wxBitmap bitmap)
void wxPGCell::SetFgCol ( const wxColour col)
void wxPGCell::SetFont ( const wxFont font)

Sets font of the cell.

Remarks
Because wxPropertyGrid does not support rows of different height, it makes little sense to change size of the font. Therefore it is recommended to use return value of wxPropertyGrid::GetFont() or wxPropertyGrid::GetCaptionFont() as a basis for the font that, after modifications, is passed to this member function.
void wxPGCell::SetText ( const wxString text)