/////////////////////////////////////////////////////////////////////////////
// Name: grid.h
-// Purpose: documentation for wxGridCellFloatRenderer class
+// Purpose: interface of wxGridCellFloatRenderer
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer,
+ @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer,
wxGridCellBoolRenderer
*/
class wxGridCellFloatRenderer : public wxGridCellStringRenderer
};
+
/**
@class wxGridTableBase
@wxheader{grid.h}
{
public:
/**
-
+
*/
wxGridTableBase();
/**
-
+
*/
~wxGridTableBase();
/**
-
+
*/
bool AppendCols(size_t numCols = 1);
/**
-
+
*/
bool AppendRows(size_t numRows = 1);
/**
-
+
*/
bool CanGetValueAs(int row, int col, const wxString& typeName);
bool CanHaveAttributes();
/**
-
+
*/
bool CanSetValueAs(int row, int col, const wxString& typeName);
/**
-
+
*/
void Clear();
/**
-
+
*/
bool DeleteCols(size_t pos = 0, size_t numCols = 1);
/**
-
+
*/
bool DeleteRows(size_t pos = 0, size_t numRows = 1);
wxGridCellAttrProvider* GetAttrProvider() const;
/**
-
+
*/
wxString GetColLabelValue(int col);
/**
-
+
*/
int GetNumberCols();
int GetNumberRows();
/**
-
+
*/
wxString GetRowLabelValue(int row);
wxString GetTypeName(int row, int col);
/**
-
+
*/
wxString GetValue(int row, int col);
/**
-
+
*/
bool GetValueAsBool(int row, int col);
const wxString& typeName);
/**
-
+
*/
double GetValueAsDouble(int row, int col);
/**
-
+
*/
long GetValueAsLong(int row, int col);
/**
-
+
*/
wxGrid* GetView() const;
/**
-
+
*/
bool InsertCols(size_t pos = 0, size_t numCols = 1);
/**
-
+
*/
bool InsertRows(size_t pos = 0, size_t numRows = 1);
/**
-
+
*/
bool IsEmptyCell(int row, int col);
void SetAttrProvider(wxGridCellAttrProvider* attrProvider);
/**
-
+
*/
void SetColAttr(wxGridCellAttr* attr, int col);
void SetColLabelValue() const;
/**
-
+
*/
void SetRowAttr(wxGridCellAttr* attr, int row);
void SetRowLabelValue() const;
/**
-
+
*/
void SetValue(int row, int col, const wxString& value);
/**
-
+
*/
void SetValueAsBool(int row, int col, bool value);
/**
-
+
*/
void SetValueAsCustom(int row, int col, const wxString& typeName,
void* value);
/**
-
+
*/
void SetValueAsDouble(int row, int col, double value);
/**
-
+
*/
void SetValueAsLong(int row, int col, long value);
void SetView(wxGrid* grid);
/**
-
+
*/
void UpdateAttrCols(size_t pos, int numCols);
};
+
/**
@class wxGridCellEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
+ @see wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
wxGridCellNumberEditor, wxGridCellChoiceEditor
*/
class wxGridCellEditor
{
public:
/**
-
+
*/
wxGridCellEditor();
void HandleReturn(wxKeyEvent& event);
/**
-
+
*/
bool IsCreated();
};
+
/**
@class wxGridCellTextEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
+ @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
wxGridCellNumberEditor, wxGridCellChoiceEditor
*/
class wxGridCellTextEditor : public wxGridCellEditor
};
+
/**
@class wxGridCellStringRenderer
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer,
+ @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer,
wxGridCellBoolRenderer
*/
class wxGridCellStringRenderer : public wxGridCellRenderer
};
+
/**
@class wxGridCellChoiceEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
+ @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
wxGridCellTextEditor, wxGridCellNumberEditor
*/
class wxGridCellChoiceEditor : public wxGridCellEditor
};
+
/**
@class wxGridEditorCreatedEvent
@wxheader{grid.h}
public:
//@{
/**
-
+
*/
wxGridEditorCreatedEvent();
wxGridEditorCreatedEvent(int id, wxEventType type,
};
+
/**
@class wxGridRangeSelectEvent
@wxheader{grid.h}
public:
//@{
/**
-
+
*/
wxGridRangeSelectEvent();
wxGridRangeSelectEvent(int id, wxEventType type,
};
+
/**
@class wxGridCellRenderer
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellStringRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer,
- wxGridCellBoolRenderer
+ @see wxGridCellStringRenderer, wxGridCellNumberRenderer,
+ wxGridCellFloatRenderer, wxGridCellBoolRenderer
*/
class wxGridCellRenderer
{
public:
/**
-
+
*/
wxGridCellRenderer* Clone() const;
};
+
/**
@class wxGridCellNumberEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
+ @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
wxGridCellTextEditor, wxGridCellChoiceEditor
*/
class wxGridCellNumberEditor : public wxGridCellTextEditor
};
+
/**
@class wxGridSizeEvent
@wxheader{grid.h}
public:
//@{
/**
-
+
*/
wxGridSizeEvent();
wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
};
+
/**
@class wxGridCellNumberRenderer
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
+ @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
wxGridCellBoolRenderer
*/
class wxGridCellNumberRenderer : public wxGridCellStringRenderer
};
+
/**
@class wxGridCellAttr
@wxheader{grid.h}
wxGridCellAttr* Clone() const;
/**
-
+
*/
void DecRef();
void GetAlignment(int* hAlign, int* vAlign) const;
/**
-
+
*/
const wxColour GetBackgroundColour() const;
/**
-
+
*/
wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
/**
-
+
*/
const wxFont GetFont() const;
/**
-
+
*/
wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
/**
-
+
*/
const wxColour GetTextColour() const;
/**
-
+
*/
bool HasAlignment() const;
/**
-
+
*/
bool HasBackgroundColour() const;
/**
-
+
*/
bool HasEditor() const;
/**
-
+
*/
bool HasFont() const;
/**
-
+
*/
bool HasRenderer() const;
void IncRef();
/**
-
+
*/
bool IsReadOnly() const;
void SetBackgroundColour(const wxColour& colBack);
/**
-
+
*/
void SetDefAttr(wxGridCellAttr* defAttr);
/**
-
+
*/
void SetEditor(wxGridCellEditor* editor);
void SetFont(const wxFont& font);
/**
-
+
*/
void SetReadOnly(bool isReadOnly = true);
};
+
/**
@class wxGridCellBoolRenderer
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
+ @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
wxGridCellNumberRenderer
*/
class wxGridCellBoolRenderer : public wxGridCellRenderer
};
+
/**
@class wxGridEvent
@wxheader{grid.h}
public:
//@{
/**
-
+
*/
wxGridEvent();
wxGridEvent(int id, wxEventType type, wxObject* obj,
};
+
/**
@class wxGridCellFloatEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor,
+ @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor,
wxGridCellTextEditor, wxGridCellChoiceEditor
*/
class wxGridCellFloatEditor : public wxGridCellTextEditor
};
+
/**
@class wxGrid
@wxheader{grid.h}
@library{wxadv}
@category{miscwnd}
- @seealso
- @ref overview_gridoverview "wxGrid overview"
+ @see @ref overview_gridoverview "wxGrid overview"
*/
class wxGrid : public wxScrolledWindow
{
/**
AutoSizeColumn()
-
+
AutoSizeRow()
-
+
AutoSizeColumns()
-
+
AutoSizeRows()
-
+
AutoSize()
-
+
SetColMinimalWidth()
-
+
SetRowMinimalHeight()
-
+
SetColMinimalAcceptableWidth()
-
+
SetRowMinimalAcceptableHeight()
-
+
GetColMinimalAcceptableWidth()
-
+
GetRowMinimalAcceptableHeight()
*/
EndBatch(). Code that does a lot of grid
modification can be enclosed between BeginBatch and EndBatch calls to avoid
screen flicker. The final EndBatch will cause the grid to be repainted.
-
+
@see wxGridUpdateLocker
*/
void BeginBatch();
/**
EnableDragRowSize()
-
+
EnableDragColSize()
-
+
CanDragRowSize()
-
+
CanDragColSize()
-
+
EnableDragColMove()
-
+
CanDragColMove()
-
+
EnableDragGridSize()
-
+
CanDragGridSize()
-
+
GetColAt()
-
+
SetColPos()
-
+
GetColPos()
-
+
EnableDragCell()
-
+
CanDragCell()
*/
/**
@ref ctor() wxGrid
-
+
@ref dtor() ~wxGrid
-
+
CreateGrid()
-
+
SetTable()
*/
/**
MoveCursorUp()
-
+
MoveCursorDown()
-
+
MoveCursorLeft()
-
+
MoveCursorRight()
-
+
MoveCursorPageUp()
-
+
MoveCursorPageDown()
-
+
MoveCursorUpBlock()
-
+
MoveCursorDownBlock()
-
+
MoveCursorLeftBlock()
-
+
MoveCursorRightBlock()
*/
EndBatch. Code that does a lot of grid modification can be enclosed between
BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
cause the grid to be repainted.
-
+
@see wxGridUpdateLocker
*/
void EndBatch();
grid cell at the specified location.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
-
+
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
Sets the arguments to the current column label alignment values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
-
+
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetColLabelAlignment(int* horiz, int* vert) const;
wxString GetColLabelValue(int col) const;
/**
-
+
*/
int GetColLeft(int col) const;
int GetColPos(int colID) const;
/**
-
+
*/
int GetColRight(int col) const;
values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
-
+
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetDefaultCellAlignment(int* horiz, int* vert) const;
//@{
/**
-
+
*/
wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
const wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
//@}
/**
-
+
*/
wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
Returns the pen used for grid lines. This virtual function may be overridden in
derived classes in order to change the appearance of grid lines. Note that
currently the pen width must be 1.
-
+
@see GetColGridLinePen(), GetRowGridLinePen()
*/
wxPen GetDefaultGridLinePen();
wxGridCellRenderer* GetDefaultRenderer() const;
/**
-
+
*/
wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
-
+
*/
wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
/**
Returns the colour used for grid lines.
-
+
@see GetDefaultGridLinePen()
*/
wxColour GetGridLineColour() const;
int GetNumberRows() const;
/**
-
+
*/
wxGridCellAttr* GetOrCreateCellAttr(int row, int col) const;
/**
Sets the arguments to the current row label alignment values.
Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT.
-
+
Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
*/
void GetRowLabelAlignment(int* horiz, int* vert) const;
int GetRowMinimalAcceptableHeight() const;
/**
-
+
*/
int GetRowMinimalHeight(int col) const;
/**
Returns the number of pixels per horizontal scroll increment. The default is 15.
-
+
@see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineX() const;
/**
Returns the number of pixels per vertical scroll increment. The default is 15.
-
+
@see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineY() const;
wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
/**
-
+
*/
wxColour GetSelectionForeground() const;
/**
EnableGridLines()
-
+
GridLinesEnabled()
-
+
SetGridLineColour()
-
+
GetGridLineColour()
-
+
GetDefaultGridLinePen()
-
+
GetRowGridLinePen()
-
+
GetColGridLinePen()
*/
void InitColWidths();
/**
- NB: @e never access m_row/col arrays directly because they are created
+ @note @e never access m_row/col arrays directly because they are created
on demand, @e always use accessor functions instead!
Init the m_rowHeights/Bottoms arrays with default values.
*/
/**
SetRowLabelValue()
-
+
SetColLabelValue()
-
+
GetRowLabelValue()
-
+
GetColLabelValue()
-
+
SetUseNativeColLabels()
-
+
HideColLabels()
-
+
HideRowLabels()
-
+
SetRowLabelSize()
-
+
SetColLabelSize()
-
+
GetRowLabelSize()
-
+
GetColLabelSize()
-
+
AutoSizeRowLabelSize()
-
+
AutoSizeColLabelSize()
-
+
GetDefaultRowLabelSize()
-
+
GetDefaultColLabelSize()
-
+
SetRowLabelAlignment()
-
+
SetColLabelAlignment()
-
+
GetRowLabelAlignment()
-
+
GetColLabelAlignment()
-
+
SetLabelFont()
-
+
SetLabelTextColour()
-
+
SetLabelBackgroundColour()
-
+
GetLabelFont()
-
+
GetLabelBackgroundColour()
-
+
GetLabelTextColour()
-
+
SetColLabelTextOrientation()
-
+
GetColLabelTextOrientation()
*/
/**
ClearSelection()
-
+
IsSelection()
-
+
SelectAll()
-
+
SelectBlock()
-
+
SelectCol()
-
+
SelectRow()
*/
location.
Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
-
+
Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or
wxALIGN_BOTTOM.
*/
//@}
/**
-
+
*/
void SetCellBackgroundColour(int row, int col,
const wxColour& colour);
int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = true);
/**
-
+
*/
int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = true);
Sets the number of pixels per horizontal scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
-
+
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
*/
void SetScrollLineX(int x);
Sets the number of pixels per vertical scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
-
+
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
*/
void SetScrollLineY(int y);
/**
-
+
*/
void SetSelectionBackground(const wxColour& c);
/**
-
+
*/
void SetSelectionForeground(const wxColour& c);
/**
Set the selection behaviour of the grid.
-
+
@param wxGridSelectCells()
The default mode where individual cells are selected.
@param wxGridSelectRows()
};
+
/**
@class wxGridCellBoolEditor
@wxheader{grid.h}
@library{wxadv}
@category{FIXME}
- @seealso
- wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor,
+ @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor,
wxGridCellTextEditor, wxGridCellChoiceEditor
*/
class wxGridCellBoolEditor : public wxGridCellEditor
};
+
/**
@class wxGridUpdateLocker
@wxheader{grid.h}
*/
void Create(wxGrid* grid);
};
+
projects / wxWidgets.git / blobdiff