Version: 3.1.0
wxGridCellDateTimeRenderer Class Reference

#include <wx/grid.h>

+ Inheritance diagram for wxGridCellDateTimeRenderer:

Detailed Description

This class may be used to format a date/time data in a cell.

The class wxDateTime is used internally to display the local date/time or to parse the string date entered in the cell thanks to the defined format.

Library:  wxAdvanced
Category:  Grid Related Classes
See also
wxGridCellRenderer, wxGridCellAutoWrapStringRenderer, wxGridCellBoolRenderer, wxGridCellEnumRenderer, wxGridCellFloatRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer

Public Member Functions

 wxGridCellDateTimeRenderer (const wxString &outformat=wxDefaultDateTimeFormat, const wxString &informat=wxDefaultDateTimeFormat)
 Date/time renderer constructor. More...
 
virtual void SetParameters (const wxString &params)
 Sets the strptime()-like format string which will be used to parse the date/time. More...
 
- Public Member Functions inherited from wxGridCellStringRenderer
 wxGridCellStringRenderer ()
 Default constructor. More...
 
- Public Member Functions inherited from wxGridCellRenderer
 wxGridCellRenderer ()
 
virtual wxGridCellRendererClone () const =0
 This function must be implemented in derived classes to return a copy of itself. More...
 
virtual void Draw (wxGrid &grid, wxGridCellAttr &attr, wxDC &dc, const wxRect &rect, int row, int col, bool isSelected)=0
 Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value. More...
 
virtual wxSize GetBestSize (wxGrid &grid, wxGridCellAttr &attr, wxDC &dc, int row, int col)=0
 Get the preferred size of the cell for its contents. More...
 
virtual wxSize GetBestHeight (wxGrid &grid, wxGridCellAttr &attr, wxDC &dc, int row, int col, int width)
 Get the preferred height of the cell at the given width. More...
 
virtual wxSize GetBestWidth (wxGrid &grid, wxGridCellAttr &attr, wxDC &dc, int row, int col, int height)
 Get the preferred width of the cell at the given height. More...
 
- Public Member Functions inherited from wxClientDataContainer
 wxClientDataContainer ()
 Default constructor. More...
 
virtual ~wxClientDataContainer ()
 Destructor. More...
 
void * GetClientData () const
 Get the untyped client data. More...
 
wxClientDataGetClientObject () const
 Get a pointer to the client data object. More...
 
void SetClientData (void *data)
 Set the untyped client data. More...
 
void SetClientObject (wxClientData *data)
 Set the client data object. More...
 
- Public Member Functions inherited from wxRefCounter
 wxRefCounter ()
 Default constructor. More...
 
void DecRef ()
 Decrements the reference count associated with this shared data and, if it reaches zero, destroys this instance of wxRefCounter releasing its memory. More...
 
int GetRefCount () const
 Returns the reference count associated with this shared data. More...
 
void IncRef ()
 Increments the reference count associated with this shared data. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxGridCellRenderer
virtual ~wxGridCellRenderer ()
 The destructor is private because only DecRef() can delete us. More...
 
- Protected Member Functions inherited from wxRefCounter
virtual ~wxRefCounter ()
 Destructor. More...
 

Constructor & Destructor Documentation

wxGridCellDateTimeRenderer::wxGridCellDateTimeRenderer ( const wxString outformat = wxDefaultDateTimeFormat,
const wxString informat = wxDefaultDateTimeFormat 
)

Date/time renderer constructor.

Parameters
outformatstrptime()-like format string used the parse the output date/time.
informatstrptime()-like format string used to parse the string entered in the cell.

Member Function Documentation

virtual void wxGridCellDateTimeRenderer::SetParameters ( const wxString params)
virtual

Sets the strptime()-like format string which will be used to parse the date/time.

Parameters
paramsstrptime()-like format string used to parse the date/time.