#include "wx/textctrl.h"
#include "wx/combobox.h"
#include "wx/dynarray.h"
-
+#include "wx/timer.h"
// Default parameters for wxGrid
//
#define WXGRID_MIN_COL_WIDTH 15
#define WXGRID_DEFAULT_SCROLLBAR_WIDTH 16
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
class WXDLLEXPORT wxGrid;
+class WXDLLEXPORT wxGridCellAttr;
+class WXDLLEXPORT wxGridCellAttrProviderData;
+class WXDLLEXPORT wxGridColLabelWindow;
+class WXDLLEXPORT wxGridCornerLabelWindow;
+class WXDLLEXPORT wxGridRowLabelWindow;
+class WXDLLEXPORT wxGridTableBase;
+class WXDLLEXPORT wxGridWindow;
+
+// ----------------------------------------------------------------------------
+// wxGridCellRenderer: this class is responsible for actually drawing the cell
+// in the grid. You may pass it to the wxGridCellAttr (below) to change the
+// format of one given cell or to wxGrid::SetDefaultRenderer() to change the
+// view of all cells. This is an ABC, you will normally use one of the
+// predefined derived classes or derive oyur own class from it.
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxGridCellRenderer
+{
+public:
+ // 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.
+ //
+ // this pure virtual function has a default implementation which will
+ // prepare the DC using the given attribute: it will draw the rectangle
+ // with the bg colour from attr and set the text colour and font
+ virtual void Draw(wxGrid& grid,
+ wxGridCellAttr& attr,
+ wxDC& dc,
+ const wxRect& rect,
+ int row, int col,
+ bool isSelected) = 0;
+};
+
+// the default renderer for the cells containing string data
+class WXDLLEXPORT wxGridCellStringRenderer : public wxGridCellRenderer
+{
+public:
+ // draw the string
+ virtual void Draw(wxGrid& grid,
+ wxGridCellAttr& attr,
+ wxDC& dc,
+ const wxRect& rect,
+ int row, int col,
+ bool isSelected);
+};
+
+
+// ----------------------------------------------------------------------------
+// wxGridCellEditor: This class is responsible for providing and manipulating
+// the in-place edit controls for the grid. Instances of wxGridCellEditor
+// (actually, instances of derived classes since it is an ABC) can be
+// associated with the cell attributes for individual cells, rows, columns, or
+// even for the entire grid.
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxGridCellEditor
+{
+public:
+ wxGridCellEditor();
+ virtual ~wxGridCellEditor();
+
+ bool IsCreated() { return m_control != NULL; }
+
+ // Creates the actual edit control
+ virtual void Create(wxWindow* parent,
+ wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ wxEvtHandler* evtHandler) = 0;
+
+ // Size and position the edit control
+ virtual void SetSize(const wxRect& rect);
+
+ // Show or hide the edit control
+ virtual void Show(bool show);
+
+ // Fetch the value from the table and prepare the edit control
+ // to begin editing. Set the focus to the edit control.
+ virtual void BeginEdit(int row, int col, wxGrid* grid,
+ wxGridCellAttr* attr) = 0;
+
+ // Complete the editing of the current cell. If saveValue is
+ // true then send the new value back to the table. Returns true
+ // if the value has changed. If necessary, the control may be
+ // destroyed.
+ virtual bool EndEdit(int row, int col, bool saveValue,
+ wxGrid* grid, wxGridCellAttr* attr) = 0;
+
+ // Reset the value in the control back to its starting value
+ virtual void Reset() = 0;
+
+ // Some types of controls on some platforms may need some help
+ // with the Return key.
+ virtual void HandleReturn(wxKeyEvent& event);
+
+ // Final cleanup
+ virtual void Destroy();
+
+protected:
+ wxControl* m_control;
+};
+
+
+class WXDLLEXPORT wxGridCellTextEditor : public wxGridCellEditor
+{
+public:
+ wxGridCellTextEditor();
+
+ virtual void Create(wxWindow* parent,
+ wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ wxEvtHandler* evtHandler);
+
+ virtual void BeginEdit(int row, int col, wxGrid* grid,
+ wxGridCellAttr* attr);
+
+ virtual bool EndEdit(int row, int col, bool saveValue,
+ wxGrid* grid, wxGridCellAttr* attr);
+
+ virtual void Reset();
+ virtual void HandleReturn(wxKeyEvent& event);
+
+
+private:
+ wxString m_startValue;
+};
+
+// ----------------------------------------------------------------------------
+// wxGridCellAttr: this class can be used to alter the cells appearance in
+// the grid by changing their colour/font/... from default. An object of this
+// class may be returned by wxGridTable::GetAttr().
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxGridCellAttr
+{
+public:
+ // ctors
+ wxGridCellAttr()
+ {
+ Init();
+ SetAlignment(0, 0);
+ }
+
+ wxGridCellAttr(const wxColour& colText,
+ const wxColour& colBack,
+ const wxFont& font,
+ int hAlign,
+ int vAlign)
+ : m_colText(colText), m_colBack(colBack), m_font(font)
+ {
+ Init();
+ SetAlignment(hAlign, vAlign);
+ }
+
+ // default copy ctor ok
+
+ // this class is ref counted: it is created with ref count of 1, so
+ // calling DecRef() once will delete it. Calling IncRef() allows to lock
+ // it until the matching DecRef() is called
+ void IncRef() { m_nRef++; }
+ void DecRef() { if ( !--m_nRef ) delete this; }
+ void SafeIncRef() { if ( this ) IncRef(); }
+ void SafeDecRef() { if ( this ) DecRef(); }
+
+ // setters
+ void SetTextColour(const wxColour& colText) { m_colText = colText; }
+ void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
+ void SetFont(const wxFont& font) { m_font = font; }
+ void SetAlignment(int hAlign, int vAlign)
+ {
+ m_hAlign = hAlign;
+ m_vAlign = vAlign;
+ }
+
+ // takes ownership of the pointer
+ void SetRenderer(wxGridCellRenderer *renderer)
+ { delete m_renderer; m_renderer = renderer; }
+
+ // accessors
+ bool HasTextColour() const { return m_colText.Ok(); }
+ bool HasBackgroundColour() const { return m_colBack.Ok(); }
+ bool HasFont() const { return m_font.Ok(); }
+ bool HasAlignment() const { return m_hAlign || m_vAlign; }
+ bool HasRenderer() const { return m_renderer != NULL; }
+
+ const wxColour& GetTextColour() const;
+ const wxColour& GetBackgroundColour() const;
+ const wxFont& GetFont() const;
+ void GetAlignment(int *hAlign, int *vAlign) const;
+ wxGridCellRenderer *GetRenderer() const;
+
+ void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; }
+
+private:
+ // the common part of all ctors
+ void Init() { m_nRef = 1; m_renderer = (wxGridCellRenderer *)NULL; }
+
+ // the dtor is private because only DecRef() can delete us
+ ~wxGridCellAttr() { delete m_renderer; }
+
+ // the ref count - when it goes to 0, we die
+ size_t m_nRef;
+
+ wxColour m_colText,
+ m_colBack;
+ wxFont m_font;
+ int m_hAlign,
+ m_vAlign;
+
+ wxGridCellRenderer *m_renderer;
+ wxGridCellAttr* m_defGridAttr;
+
+ // suppress the stupid gcc warning about the class having private dtor and
+ // no friends
+ friend class wxGridCellAttrDummyFriend;
+};
+
+// ----------------------------------------------------------------------------
+// wxGridCellAttrProvider: class used by wxGridTableBase to retrieve/store the
+// cell attributes.
+// ----------------------------------------------------------------------------
+// implementation note: we separate it from wxGridTableBase because we wish to
+// avoid deriving a new table class if possible, and sometimes it will be
+// enough to just derive another wxGridCellAttrProvider instead
+//
+// the default implementation is reasonably efficient for the generic case,
+// but you might still wish to implement your own for some specific situations
+// if you have performance problems with the stock one
+class WXDLLEXPORT wxGridCellAttrProvider
+{
+public:
+ wxGridCellAttrProvider();
+ virtual ~wxGridCellAttrProvider();
+
+ // DecRef() must be called on the returned pointer
+ virtual wxGridCellAttr *GetAttr(int row, int col) const;
+
+ // all these functions take ownership of the pointer, don't call DecRef()
+ // on it
+ virtual void SetAttr(wxGridCellAttr *attr, int row, int col);
+ virtual void SetRowAttr(wxGridCellAttr *attr, int row);
+ virtual void SetColAttr(wxGridCellAttr *attr, int col);
+
+private:
+ void InitData();
+
+ wxGridCellAttrProviderData *m_data;
+};
//////////////////////////////////////////////////////////////////////
//
class WXDLLEXPORT wxGridTableBase : public wxObject
{
- wxGrid * m_view;
-
- public:
+public:
wxGridTableBase();
virtual ~wxGridTableBase();
virtual wxString GetValue( int row, int col ) = 0;
virtual void SetValue( int row, int col, const wxString& s ) = 0;
virtual bool IsEmptyCell( int row, int col ) = 0;
-
+
// Overriding these is optional
//
virtual void SetView( wxGrid *grid ) { m_view = grid; }
virtual wxString GetColLabelValue( int col );
virtual void SetRowLabelValue( int WXUNUSED(row), const wxString& ) {}
virtual void SetColLabelValue( int WXUNUSED(col), const wxString& ) {}
-
+
+ // Attribute handling
+ //
+
+ // give us the attr provider to use - we take ownership of the pointer
+ void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
+
+ // get the currently used attr provider (may be NULL)
+ wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; }
+
+ // by default forwarded to wxGridCellAttrProvider if any. May be
+ // overridden to handle attributes directly in this class.
+ virtual wxGridCellAttr *GetAttr( int row, int col );
+
+ // these functions take ownership of the pointer
+ virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
+ virtual void SetRowAttr(wxGridCellAttr *attr, int row);
+ virtual void SetColAttr(wxGridCellAttr *attr, int col);
+
+private:
+ wxGrid * m_view;
+ wxGridCellAttrProvider *m_attrProvider;
+
DECLARE_ABSTRACT_CLASS( wxGridTableBase );
};
+// ----------------------------------------------------------------------------
+// wxGridTableMessage
+// ----------------------------------------------------------------------------
// IDs for messages sent from grid table to view
//
-enum wxGridTableRequest {
+enum wxGridTableRequest
+{
wxGRIDTABLE_REQUEST_VIEW_GET_VALUES = 2000,
wxGRIDTABLE_REQUEST_VIEW_SEND_VALUES,
wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
class WXDLLEXPORT wxGridTableMessage
{
- wxGridTableBase *m_table;
- int m_id;
- int m_comInt1;
- int m_comInt2;
-
- public:
+public:
wxGridTableMessage();
wxGridTableMessage( wxGridTableBase *table, int id,
int comInt1 = -1,
void SetCommandInt( int comInt1 ) { m_comInt1 = comInt1; }
int GetCommandInt() { return m_comInt1; }
void SetCommandInt2( int comInt2 ) { m_comInt2 = comInt2; }
- int GetCommandInt2() { return m_comInt2; }
+ int GetCommandInt2() { return m_comInt2; }
+
+private:
+ wxGridTableBase *m_table;
+ int m_id;
+ int m_comInt1;
+ int m_comInt2;
};
class WXDLLEXPORT wxGridStringTable : public wxGridTableBase
{
- wxGridStringArray m_data;
-
- // These only get used if you set your own labels, otherwise the
- // GetRow/ColLabelValue functions return wxGridTableBase defaults
- //
- wxArrayString m_rowLabels;
- wxArrayString m_colLabels;
-
- public:
+public:
wxGridStringTable();
wxGridStringTable( int numRows, int numCols );
~wxGridStringTable();
wxString GetValue( int row, int col );
void SetValue( int row, int col, const wxString& s );
bool IsEmptyCell( int row, int col );
-
+
// overridden functions from wxGridTableBase
//
void Clear();
void SetColLabelValue( int col, const wxString& );
wxString GetRowLabelValue( int row );
wxString GetColLabelValue( int col );
-
+
+private:
+ wxGridStringArray m_data;
+
+ // These only get used if you set your own labels, otherwise the
+ // GetRow/ColLabelValue functions return wxGridTableBase defaults
+ //
+ wxArrayString m_rowLabels;
+ wxArrayString m_colLabels;
+
DECLARE_DYNAMIC_CLASS( wxGridStringTable )
};
class WXDLLEXPORT wxGridCellCoords
{
- long m_row;
- long m_col;
-
- public:
+public:
wxGridCellCoords() { m_row = m_col = -1; }
wxGridCellCoords( int r, int c ) { m_row = r; m_col = c; }
long GetCol() const { return m_col; }
void SetCol( long n ) { m_col = n; }
void Set( long row, long col ) { m_row = row; m_col = col; }
-
+
wxGridCellCoords& operator=( const wxGridCellCoords& other )
{
if ( &other != this )
{
return (m_row == -1 && m_col == -1 );
}
+
+private:
+ long m_row;
+ long m_col;
};
// This set of classes is to provide for the use of different types of
-// cell edit controls in the grid while avoiding the wx class info
+// cell edit controls in the grid while avoiding the wx class info
// system in deference to wxPython
class WXDLLEXPORT wxGridTextCtrl : public wxTextCtrl
{
- wxGrid *m_grid;
-
- // TRUE for controls placed over cells,
- // FALSE for a control on a grid control panel
- bool m_isCellControl;
-
- wxString startValue;
-
- void OnKeyDown( wxKeyEvent& );
-
- public:
+public:
wxGridTextCtrl() {}
wxGridTextCtrl( wxWindow *,
wxGrid *,
void SetStartValue( const wxString& );
wxString GetStartValue() { return startValue; }
-
- DECLARE_DYNAMIC_CLASS( wxGridTextCtrl )
- DECLARE_EVENT_TABLE()
-};
-
-
-class WXDLLEXPORT wxGridRowLabelWindow : public wxWindow
-{
- wxGrid *m_owner;
-
- void OnPaint( wxPaintEvent& event );
- void OnMouseEvent( wxMouseEvent& event );
- void OnKeyDown( wxKeyEvent& event );
-
-public:
- wxGridRowLabelWindow() {}
- wxGridRowLabelWindow( wxGrid *parent, wxWindowID id,
- const wxPoint &pos, const wxSize &size );
-
- DECLARE_DYNAMIC_CLASS(wxGridRowLabelWindow)
- DECLARE_EVENT_TABLE()
-};
+private:
+ wxGrid *m_grid;
-class WXDLLEXPORT wxGridColLabelWindow : public wxWindow
-{
- wxGrid *m_owner;
-
- void OnPaint( wxPaintEvent &event );
- void OnMouseEvent( wxMouseEvent& event );
- void OnKeyDown( wxKeyEvent& event );
+ // TRUE for controls placed over cells,
+ // FALSE for a control on a grid control panel
+ bool m_isCellControl;
-public:
- wxGridColLabelWindow() {}
- wxGridColLabelWindow( wxGrid *parent, wxWindowID id,
- const wxPoint &pos, const wxSize &size );
-
- DECLARE_DYNAMIC_CLASS(wxGridColLabelWindow)
- DECLARE_EVENT_TABLE()
-};
+ wxString startValue;
+ void OnKeyDown( wxKeyEvent& );
-class WXDLLEXPORT wxGridCornerLabelWindow : public wxWindow
-{
- wxGrid *m_owner;
-
- void OnMouseEvent( wxMouseEvent& event );
- void OnKeyDown( wxKeyEvent& event );
-
- public:
- wxGridCornerLabelWindow() {}
- wxGridCornerLabelWindow( wxGrid *parent, wxWindowID id,
- const wxPoint &pos, const wxSize &size );
-
- DECLARE_DYNAMIC_CLASS(wxGridCornerLabelWindow)
+ DECLARE_DYNAMIC_CLASS( wxGridTextCtrl )
DECLARE_EVENT_TABLE()
};
+//-----------------------------------------------------------------------------
+// wxGridEditTimer (internal)
+//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxGridWindow : public wxPanel
+class WXDLLEXPORT wxGridEditTimer: public wxTimer
{
- wxGrid *m_owner;
- wxGridRowLabelWindow *m_rowLabelWin;
- wxGridColLabelWindow *m_colLabelWin;
-
- void OnPaint( wxPaintEvent &event );
- void OnMouseEvent( wxMouseEvent& event );
- void OnKeyDown( wxKeyEvent& );
+ private:
+ wxGrid *m_owner;
-public:
- wxGridWindow() {}
- wxGridWindow( wxGrid *parent,
- wxGridRowLabelWindow *rowLblWin,
- wxGridColLabelWindow *colLblWin,
- wxWindowID id, const wxPoint &pos, const wxSize &size );
- ~wxGridWindow();
-
- void ScrollWindow( int dx, int dy, const wxRect *rect );
-
- DECLARE_DYNAMIC_CLASS(wxGridWindow)
- DECLARE_EVENT_TABLE()
+ public:
+ wxGridEditTimer( wxGrid *owner );
+ void Notify();
};
-
+// ----------------------------------------------------------------------------
+// wxGrid
+// ----------------------------------------------------------------------------
class WXDLLEXPORT wxGrid : public wxScrolledWindow
{
- protected:
- bool m_created;
-
- wxGridWindow *m_gridWin;
- wxGridRowLabelWindow *m_rowLabelWin;
- wxGridColLabelWindow *m_colLabelWin;
- wxGridCornerLabelWindow *m_cornerLabelWin;
-
- wxBoxSizer *m_mainSizer;
- wxBoxSizer *m_topSizer;
- wxBoxSizer *m_middleSizer;
-
- wxGridTableBase *m_table;
-
- int m_left;
- int m_top;
- int m_right;
- int m_bottom;
-
- int m_numRows;
- int m_numCols;
-
- wxGridCellCoords m_currentCellCoords;
-
- wxGridCellCoords m_selectedTopLeft;
- wxGridCellCoords m_selectedBottomRight;
-
- int m_defaultRowHeight;
- wxArrayInt m_rowHeights;
- wxArrayInt m_rowBottoms;
-
- int m_defaultColWidth;
- wxArrayInt m_colWidths;
- wxArrayInt m_colRights;
-
- int m_rowLabelWidth;
- int m_colLabelHeight;
-
- wxColour m_labelBackgroundColour;
- wxColour m_labelTextColour;
- wxFont m_labelFont;
-
- int m_rowLabelHorizAlign;
- int m_rowLabelVertAlign;
- int m_colLabelHorizAlign;
- int m_colLabelVertAlign;
-
- bool m_defaultRowLabelValues;
- bool m_defaultColLabelValues;
-
- wxColour m_gridLineColour;
- bool m_gridLinesEnabled;
-
- wxFont m_defaultCellFont;
-
- wxGridCellCoordsArray m_cellsExposed;
- wxArrayInt m_rowsExposed;
- wxArrayInt m_colsExposed;
- wxArrayInt m_rowLabelsExposed;
- wxArrayInt m_colLabelsExposed;
-
- bool m_inOnKeyDown;
- int m_batchCount;
-
- int m_cursorMode;
- enum { WXGRID_CURSOR_DEFAULT,
- WXGRID_CURSOR_SELECT_CELL,
- WXGRID_CURSOR_RESIZE_ROW,
- WXGRID_CURSOR_RESIZE_COL,
- WXGRID_CURSOR_SELECT_ROW,
- WXGRID_CURSOR_SELECT_COL
- };
-
- int m_dragLastPos;
- int m_dragRowOrCol;
- bool m_isDragging;
-
- wxGridCellCoords m_selectionStart;
-
- wxCursor m_rowResizeCursor;
- wxCursor m_colResizeCursor;
-
- bool m_editable; // applies to whole grid
- int m_editCtrlType; // for current cell
- wxWindow* m_cellEditCtrl;
- bool m_cellEditCtrlEnabled;
-
-
- void Create();
- void Init();
- void CalcDimensions();
- bool Redimension( wxGridTableMessage& );
-
-
- bool SendEvent( const wxEventType,
- int row, int col,
- wxMouseEvent& );
-
- bool SendEvent( const wxEventType,
- int row, int col );
-
-
- void OnPaint( wxPaintEvent& );
- void OnSize( wxSizeEvent& );
- void OnKeyDown( wxKeyEvent& );
-
-
- void SetCurrentCell( const wxGridCellCoords& coords );
- void SetCurrentCell( int row, int col )
- { SetCurrentCell( wxGridCellCoords(row, col) ); }
-
-
- // ------ functions to get/send data (see also public functions)
- //
- bool GetModelValues();
- bool SetModelValues();
-
-
- ////////////////////// Public section ////////////////////
-
- public:
+public:
wxGrid()
- { Create(); }
-
+ {
+ m_table = (wxGridTableBase *) NULL;
+ m_gridWin = (wxGridWindow *) NULL;
+ m_rowLabelWin = (wxGridRowLabelWindow *) NULL;
+ m_colLabelWin = (wxGridColLabelWindow *) NULL;
+ m_cornerLabelWin = (wxGridCornerLabelWindow *) NULL;
+ m_cellEditCtrl = (wxWindow *) NULL;
+ }
+
wxGrid( wxWindow *parent,
wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
long style = 0,
const wxString& name = wxPanelNameStr );
- ~wxGrid();
+ ~wxGrid();
bool CreateGrid( int numRows, int numCols );
-
+
// ------ grid dimensions
//
int GetNumberRows() { return m_numRows; }
int GetNumberCols() { return m_numCols; }
-
+
// ------ display update functions
//
- void CalcRowLabelsExposed( wxRegion& reg );
- void CalcColLabelsExposed( wxRegion& reg );
- void CalcCellsExposed( wxRegion& reg );
+ void CalcRowLabelsExposed( wxRegion& reg );
+
+ void CalcColLabelsExposed( wxRegion& reg );
+ void CalcCellsExposed( wxRegion& reg );
+
-
// ------ event handlers
//
void ProcessRowLabelMouseEvent( wxMouseEvent& event );
void ProcessColLabelMouseEvent( wxMouseEvent& event );
void ProcessCornerLabelMouseEvent( wxMouseEvent& event );
- void ProcessGridCellMouseEvent( wxMouseEvent& event );
+ void ProcessGridCellMouseEvent( wxMouseEvent& event );
bool ProcessTableMessage( wxGridTableMessage& );
-
+ void DoEndDragResizeRow();
+ void DoEndDragResizeCol();
+
wxGridTableBase * GetTable() const { return m_table; }
- void SetTable( wxGridTableBase *table ) { m_table = table; }
+ bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE );
void ClearGrid();
bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
bool DeleteRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
bool InsertCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
bool AppendCols( int numCols = 1, bool updateLabels=TRUE );
- bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
+ bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE );
void DrawGridCellArea( wxDC& dc );
void DrawCellBorder( wxDC& dc, const wxGridCellCoords& );
- void DrawAllGridLines( wxDC& dc ); // TODO - delete this ?
+ void DrawAllGridLines( wxDC& dc, const wxRegion & reg );
void DrawCell( wxDC& dc, const wxGridCellCoords& );
- void DrawCellBackground( wxDC& dc, const wxGridCellCoords& );
- void DrawCellValue( wxDC& dc, const wxGridCellCoords& );
void DrawRowLabels( wxDC& dc );
void DrawRowLabel( wxDC& dc, int row );
+
void DrawColLabels( wxDC& dc );
void DrawColLabel( wxDC& dc, int col );
-
+
// ------ Cell text drawing functions
//
// strings and return the number of lines
//
void StringToLines( const wxString& value, wxArrayString& lines );
-
+
void GetTextBoxSize( wxDC& dc,
wxArrayString& lines,
long *width, long *height );
-
+
// ------
// Code that does a lot of grid modification can be enclosed
bool IsEditable() { return m_editable; }
void EnableEditing( bool edit );
-#if 0 // at the moment the cell edit control is always active
void EnableCellEditControl( bool enable );
-#endif
bool IsCellEditControlEnabled()
{ return (m_cellEditCtrl && m_cellEditCtrlEnabled); }
void SetEditControlValue( const wxString& s = wxEmptyString );
void SaveEditControlValue();
-
+
// ------ grid location functions
- // Note that all of these functions work with the logical coordinates of
+ // Note that all of these functions work with the logical coordinates of
// grid cells and labels so you will need to convert from device
// coordinates for mouse events etc.
//
int GetGridCursorRow() { return m_currentCellCoords.GetRow(); }
int GetGridCursorCol() { return m_currentCellCoords.GetCol(); }
-
+
// check to see if a cell is either wholly visible (the default arg) or
// at least partially visible in the grid window
//
void MakeCellVisible( const wxGridCellCoords& coords )
{ MakeCellVisible( coords.GetRow(), coords.GetCol() ); }
-
+
// ------ grid cursor movement functions
//
+ void SetGridCursor( int row, int col )
+ { SetCurrentCell( wxGridCellCoords(row, col) ); }
+
bool MoveCursorUp();
bool MoveCursorDown();
bool MoveCursorLeft();
bool MoveCursorLeftBlock();
bool MoveCursorRightBlock();
-
+
// ------ label and gridline formatting
//
int GetDefaultRowLabelSize() { return WXGRID_DEFAULT_ROW_LABEL_WIDTH; }
int GetRowLabelSize() { return m_rowLabelWidth; }
- int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
+ int GetDefaultColLabelSize() { return WXGRID_DEFAULT_COL_LABEL_HEIGHT; }
int GetColLabelSize() { return m_colLabelHeight; }
wxColour GetLabelBackgroundColour() { return m_labelBackgroundColour; }
wxColour GetLabelTextColour() { return m_labelTextColour; }
wxString GetColLabelValue( int col );
wxColour GetGridLineColour() { return m_gridLineColour; }
- void SetRowLabelSize( int width );
+ void SetRowLabelSize( int width );
void SetColLabelSize( int height );
void SetLabelBackgroundColour( const wxColour& );
void SetLabelTextColour( const wxColour& );
void SetColLabelValue( int col, const wxString& );
void SetGridLineColour( const wxColour& );
+ // this sets the specified attribute for all cells in this row/col
+ void SetRowAttr(int row, wxGridCellAttr *attr);
+ void SetColAttr(int col, wxGridCellAttr *attr);
+
void EnableGridLines( bool enable = TRUE );
bool GridLinesEnabled() { return m_gridLinesEnabled; }
-
// ------ row and col formatting
//
int GetDefaultRowSize();
wxFont GetCellFont( int row, int col );
void GetDefaultCellAlignment( int *horiz, int *vert );
void GetCellAlignment( int row, int col, int *horiz, int *vert );
-
+
void SetDefaultRowSize( int height, bool resizeExistingRows = FALSE );
void SetRowSize( int row, int height );
void SetDefaultColSize( int width, bool resizeExistingCols = FALSE );
+
void SetColSize( int col, int width );
void SetDefaultCellBackgroundColour( const wxColour& );
void SetCellBackgroundColour( int row, int col, const wxColour& );
void SetDefaultCellTextColour( const wxColour& );
+
void SetCellTextColour( int row, int col, const wxColour& );
void SetDefaultCellFont( const wxFont& );
void SetCellFont( int row, int col, const wxFont& );
void SetDefaultCellAlignment( int horiz, int vert );
void SetCellAlignment( int row, int col, int horiz, int vert );
+ // takes ownership of the pointer
+ void SetDefaultRenderer(wxGridCellRenderer *renderer);
+ void SetCellRenderer(int row, int col, wxGridCellRenderer *renderer);
+ wxGridCellRenderer *GetDefaultRenderer() const;
+ wxGridCellRenderer* GetCellRenderer(int row, int col);
+
// ------ cell value accessors
//
wxString GetCellValue( const wxGridCellCoords& coords )
{ return GetCellValue( coords.GetRow(), coords.GetCol() ); }
-
+
void SetCellValue( int row, int col, const wxString& s );
void SetCellValue( const wxGridCellCoords& coords, const wxString& s )
{ SetCellValue( coords.GetRow(), coords.GetCol(), s ); }
-
+
// ------ selections of blocks of cells
//
void SelectRow( int row, bool addToSelected = FALSE );
void SelectCol( int col, bool addToSelected = FALSE );
-
+
void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol );
void SelectBlock( const wxGridCellCoords& topLeft,
bottomRight.GetRow(), bottomRight.GetCol() ); }
void SelectAll();
-
+
bool IsSelection()
{ return ( m_selectedTopLeft != wxGridNoCellCoords &&
m_selectedBottomRight != wxGridNoCellCoords );
*rightCol = m_selectedBottomRight.GetCol();
}
+
+ // This function returns the rectangle that encloses the block of cells
+ // limited by TopLeft and BottomRight cell in device coords and clipped
+ // to the client size of the grid window.
+ //
+ wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
+ const wxGridCellCoords & bottomRight );
+
// This function returns the rectangle that encloses the selected cells
// in device coords and clipped to the client size of the grid window.
//
- wxRect SelectionToDeviceRect();
-
-
+ wxRect SelectionToDeviceRect()
+ {
+ return BlockToDeviceRect( m_selectedTopLeft,
+ m_selectedBottomRight );
+ }
+
+ // Access or update the selection fore/back colours
+ wxColour GetSelectionBackground() const
+ { return m_selectionBackground; }
+ wxColour GetSelectionForeground() const
+ { return m_selectionForeground; }
+
+ void SetSelectionBackground(const wxColour& c) { m_selectionBackground = c; }
+ void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; }
+
+
// ------ For compatibility with previous wxGrid only...
//
long style = 0,
const wxString& name = wxPanelNameStr )
: wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h), style, name )
- {
+ {
Create();
- }
+ }
void SetCellValue( const wxString& val, int row, int col )
{ SetCellValue( row, col, val ); }
-
+
void UpdateDimensions()
{ CalcDimensions(); }
int GetCols() { return GetNumberCols(); }
int GetCursorRow() { return GetGridCursorRow(); }
int GetCursorColumn() { return GetGridCursorCol(); }
-
+
int GetScrollPosX() { return 0; }
int GetScrollPosY() { return 0; }
-
+
void SetScrollX( int x ) { }
void SetScrollY( int y ) { }
void SetColumnWidth( int col, int width )
{ SetColSize( col, width ); }
-
+
int GetColumnWidth( int col )
{ return GetColSize( col ); }
-
+
void SetRowHeight( int row, int height )
{ SetRowSize( row, height ); }
-
+
int GetRowHeight( int row )
{ return GetRowSize( row ); }
-
+
int GetViewHeight() // returned num whole rows visible
{ return 0; }
-
+
int GetViewWidth() // returned num whole cols visible
{ return 0; }
else
SetRowLabelValue( pos, val );
}
-
+
wxString GetLabelValue( int orientation, int pos)
{
if ( orientation == wxHORIZONTAL )
return GetRowLabelValue( pos );
}
- wxFont GetCellTextFont() const
- { return m_defaultCellFont; }
-
+ wxFont GetCellTextFont() const
+ { return m_defaultCellAttr->GetFont(); }
+
wxFont GetCellTextFont(int WXUNUSED(row), int WXUNUSED(col)) const
- { return m_defaultCellFont; }
-
+ { return m_defaultCellAttr->GetFont(); }
+
void SetCellTextFont(const wxFont& fnt)
{ SetDefaultCellFont( fnt ); }
-
+
void SetCellTextFont(const wxFont& fnt, int row, int col)
{ SetCellFont( row, col, fnt ); }
-
+
void SetCellTextColour(const wxColour& val, int row, int col)
{ SetCellTextColour( row, col, val ); }
-
+
void SetCellTextColour(const wxColour& col)
{ SetDefaultCellTextColour( col ); }
-
+
void SetCellBackgroundColour(const wxColour& col)
{ SetDefaultCellBackgroundColour( col ); }
-
+
void SetCellBackgroundColour(const wxColour& colour, int row, int col)
{ SetCellBackgroundColour( row, col, colour ); }
-
+
bool GetEditable() { return IsEditable(); }
void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); }
bool GetEditInPlace() { return IsCellEditControlEnabled(); }
+
void SetEditInPlace(bool edit = TRUE) { }
void SetCellAlignment( int align, int row, int col)
void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
wxPen& GetDividerPen() const { return wxNullPen; }
void OnActivate(bool WXUNUSED(active)) {}
-
+
// ******** End of compatibility functions **********
wxGRID_CHOICE,
wxGRID_COMBOBOX };
-
+protected:
+ bool m_created;
+ bool m_displayed;
+
+ wxGridWindow *m_gridWin;
+ wxGridRowLabelWindow *m_rowLabelWin;
+ wxGridColLabelWindow *m_colLabelWin;
+ wxGridCornerLabelWindow *m_cornerLabelWin;
+
+ wxGridTableBase *m_table;
+ bool m_ownTable;
+
+ int m_left;
+ int m_top;
+ int m_right;
+ int m_bottom;
+
+ int m_numRows;
+ int m_numCols;
+
+ wxGridCellCoords m_currentCellCoords;
+
+ wxGridCellCoords m_selectedTopLeft;
+ wxGridCellCoords m_selectedBottomRight;
+ wxColour m_selectionBackground;
+ wxColour m_selectionForeground;
+
+ int m_defaultRowHeight;
+ wxArrayInt m_rowHeights;
+ wxArrayInt m_rowBottoms;
+
+ int m_defaultColWidth;
+ wxArrayInt m_colWidths;
+ wxArrayInt m_colRights;
+
+ int m_rowLabelWidth;
+ int m_colLabelHeight;
+
+ wxColour m_labelBackgroundColour;
+ wxColour m_labelTextColour;
+ wxFont m_labelFont;
+
+ int m_rowLabelHorizAlign;
+ int m_rowLabelVertAlign;
+ int m_colLabelHorizAlign;
+ int m_colLabelVertAlign;
+
+ bool m_defaultRowLabelValues;
+ bool m_defaultColLabelValues;
+
+ wxColour m_gridLineColour;
+ bool m_gridLinesEnabled;
+
+
+ // do we have some place to store attributes in?
+ bool CanHaveAttributes();
+
+ // returns the attribute we may modify in place: a new one if this cell
+ // doesn't have any yet or the existing one if it does
+ //
+ // DecRef() must be called on the returned pointer, as usual
+ wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
+
+ // cell attribute cache (currently we only cache 1, may be will do
+ // more/better later)
+ struct CachedAttr
+ {
+ int row, col;
+ wxGridCellAttr *attr;
+ } m_attrCache;
+
+ // invalidates the attribute cache
+ void ClearAttrCache();
+
+ // adds an attribute to cache
+ void CacheAttr(int row, int col, wxGridCellAttr *attr) const;
+
+ // looks for an attr in cache, returns TRUE if found
+ bool LookupAttr(int row, int col, wxGridCellAttr **attr) const;
+
+ // looks for the attr in cache, if not found asks the table and caches the
+ // result
+ wxGridCellAttr *GetCellAttr(int row, int col) const;
+
+ // the default cell attr object for cells that don't have their own
+ wxGridCellAttr* m_defaultCellAttr;
+
+
+ wxGridCellCoordsArray m_cellsExposed;
+ wxArrayInt m_rowsExposed;
+ wxArrayInt m_colsExposed;
+ wxArrayInt m_rowLabelsExposed;
+ wxArrayInt m_colLabelsExposed;
+
+ bool m_inOnKeyDown;
+ int m_batchCount;
+
+ enum CursorMode
+ {
+ WXGRID_CURSOR_SELECT_CELL,
+ WXGRID_CURSOR_RESIZE_ROW,
+ WXGRID_CURSOR_RESIZE_COL,
+ WXGRID_CURSOR_SELECT_ROW,
+ WXGRID_CURSOR_SELECT_COL
+ };
+
+ // this method not only sets m_cursorMode but also sets the correct cursor
+ // for the given mode and, if captureMouse is not FALSE releases the mouse
+ // if it was captured and captures it if it must be captured
+ //
+ // for this to work, you should always use it and not set m_cursorMode
+ // directly!
+ void ChangeCursorMode(CursorMode mode,
+ wxWindow *win = (wxWindow *)NULL,
+ bool captureMouse = TRUE);
+
+ wxWindow *m_winCapture; // the window which captured the mouse
+ CursorMode m_cursorMode;
+
+ int m_dragLastPos;
+ int m_dragRowOrCol;
+ bool m_isDragging;
+
+ wxTimer *m_editTimer;
+
+ wxGridCellCoords m_selectionStart;
+
+ wxCursor m_rowResizeCursor;
+ wxCursor m_colResizeCursor;
+
+ bool m_editable; // applies to whole grid
+ int m_editCtrlType; // for current cell
+ wxWindow* m_cellEditCtrl;
+ bool m_cellEditCtrlEnabled;
+
+
+ void Create();
+ void Init();
+ void CalcDimensions();
+ void CalcWindowSizes();
+ bool Redimension( wxGridTableMessage& );
+
+
+ bool SendEvent( const wxEventType,
+ int row, int col,
+ wxMouseEvent& );
+
+ bool SendEvent( const wxEventType,
+ int row, int col );
+
+
+ void OnPaint( wxPaintEvent& );
+ void OnSize( wxSizeEvent& );
+ void OnKeyDown( wxKeyEvent& );
+ void OnEraseBackground( wxEraseEvent& );
+
+
+ void SetCurrentCell( const wxGridCellCoords& coords );
+ void SetCurrentCell( int row, int col )
+ { SetCurrentCell( wxGridCellCoords(row, col) ); }
+
+
+ // ------ functions to get/send data (see also public functions)
+ //
+ bool GetModelValues();
+ bool SetModelValues();
+
+
DECLARE_DYNAMIC_CLASS( wxGrid )
DECLARE_EVENT_TABLE()
};
class WXDLLEXPORT wxGridEvent : public wxNotifyEvent
{
- protected:
- int m_row;
- int m_col;
- int m_x;
- int m_y;
- bool m_control;
- bool m_meta;
- bool m_shift;
- bool m_alt;
-
- public:
+public:
wxGridEvent()
: wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
m_control(0), m_meta(0), m_shift(0), m_alt(0)
bool ShiftDown() { return m_shift; }
bool AltDown() { return m_alt; }
- DECLARE_DYNAMIC_CLASS(wxGridEvent)
-};
-
-
-class WXDLLEXPORT wxGridSizeEvent : public wxNotifyEvent
-{
- protected:
- int m_rowOrCol;
+protected:
+ int m_row;
+ int m_col;
int m_x;
int m_y;
bool m_control;
bool m_meta;
bool m_shift;
bool m_alt;
-
- public:
+
+ DECLARE_DYNAMIC_CLASS(wxGridEvent)
+};
+
+
+class WXDLLEXPORT wxGridSizeEvent : public wxNotifyEvent
+{
+public:
wxGridSizeEvent()
: wxNotifyEvent(), m_rowOrCol(-1), m_x(-1), m_y(-1),
m_control(0), m_meta(0), m_shift(0), m_alt(0)
bool ShiftDown() { return m_shift; }
bool AltDown() { return m_alt; }
+protected:
+ int m_rowOrCol;
+ int m_x;
+ int m_y;
+ bool m_control;
+ bool m_meta;
+ bool m_shift;
+ bool m_alt;
+
DECLARE_DYNAMIC_CLASS(wxGridSizeEvent)
};
class WXDLLEXPORT wxGridRangeSelectEvent : public wxNotifyEvent
{
- protected:
- wxGridCellCoords m_topLeft;
- wxGridCellCoords m_bottomRight;
- bool m_control;
- bool m_meta;
- bool m_shift;
- bool m_alt;
-
- public:
+public:
wxGridRangeSelectEvent()
- : wxNotifyEvent()
- {
- m_topLeft = wxGridNoCellCoords;
- m_bottomRight = wxGridNoCellCoords;
- m_control = FALSE;
- m_meta = FALSE;
- m_shift = FALSE;
- m_alt = FALSE;
- }
+ : wxNotifyEvent()
+ {
+ m_topLeft = wxGridNoCellCoords;
+ m_bottomRight = wxGridNoCellCoords;
+ m_control = FALSE;
+ m_meta = FALSE;
+ m_shift = FALSE;
+ m_alt = FALSE;
+ }
wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj,
- const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight,
- bool control=FALSE, bool shift=FALSE,
- bool alt=FALSE, bool meta=FALSE);
+ const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight,
+ bool control=FALSE, bool shift=FALSE,
+ bool alt=FALSE, bool meta=FALSE);
wxGridCellCoords GetTopLeftCoords() { return m_topLeft; }
wxGridCellCoords GetBottomRightCoords() { return m_bottomRight; }
bool ShiftDown() { return m_shift; }
bool AltDown() { return m_alt; }
+protected:
+ wxGridCellCoords m_topLeft;
+ wxGridCellCoords m_bottomRight;
+ bool m_control;
+ bool m_meta;
+ bool m_shift;
+ bool m_alt;
+
DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent)
};
#define EVT_GRID_ROW_SIZE(fn) { EVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
#define EVT_GRID_COL_SIZE(fn) { EVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL },
#define EVT_GRID_RANGE_SELECT(fn) { EVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL },
-#define EVT_GRID_CELL_CHANGE(fn) { EVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
+#define EVT_GRID_CELL_CHANGE(fn) { EVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
#define EVT_GRID_SELECT_CELL(fn) { EVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL },
#endif // #ifndef __WXGRID_H__
#endif // ifndef wxUSE_NEW_GRID
+
projects / wxWidgets.git / blobdiff