%% Name: grid.tex
%% Purpose: wxGrid
%% Author:
-%% Modified by:
+%% Modified by: Santiago Palacios
%% Created:
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets
+\membersection{wxGrid::CanDragColMove}\label{wxgridcandragcolmove}
+
+\func{bool}{CanDragColMove}{\void}
+
+Returns true if columns can be moved by dragging with the mouse. Columns can be moved
+by dragging on their labels.
+
+
+
\membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize}
\func{bool}{CanDragColSize}{\void}
+\membersection{wxGrid::DisableDragColMove}\label{wxgriddisabledragcolmove}
+
+\func{void}{DisableDragColMove}{\void}
+
+Disables column moving by dragging with the mouse. Equivalent to passing false to
+\helpref{wxGrid::EnableDragColMove}{wxgridenabledragcolmove}.
+
+
+
\membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize}
\func{void}{DisableDragColSize}{\void}
+\membersection{wxGrid::EnableDragColMove}\label{wxgridenabledragcolmove}
+
+\func{void}{EnableDragColMove}{\param{bool }{enable = true}}
+
+Enables or disables column moving by dragging with the mouse.
+
+
+
\membersection{wxGrid::EnableDragGridSize}\label{wxgridenabledraggridsize}
\func{void}{EnableDragGridSize}{\param{bool }{enable = true}}
+\membersection{wxGrid::GetColAt}\label{wxgridgetcolat}
+
+\constfunc{int}{GetColAt}{\param{int }{colPos}}
+
+Returns the column ID of the specified column position.
+
+
\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
\constfunc{int}{GetColLeft}{\param{int }{col}}
+\membersection{wxGrid::GetColPos}\label{wxgridgetcolpos}
+
+\constfunc{int}{GetColPos}{\param{int }{colID}}
+
+Returns the position of the specified column.
+
+
+
\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
\constfunc{int}{GetColRight}{\param{int }{col}}
Returns the colour used for grid lines.
+\wxheading{See also}
+
+\helpref{GetDefaultGridLinePen()}{wxgridgetdefaultgridlinepen}
+
+
+\membersection{wxGrid::GetDefaultGridLinePen}\label{wxgridgetdefaultgridlinepen}
+
+\func{wxPen}{GetDefaultGridLinePen}{\void}
+
+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$.
+
+\wxheading{See also}
+
+\helpref{GetColGridLinePen()}{wxgridgetcolgridlinepen},\\
+\helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen}
+
+
+
+
+\membersection{wxGrid::GetRowGridLinePen}\label{wxgridgetrowgridlinepen}
+
+\func{wxPen}{GetRowGridLinePen}{\param{int }{row}}
+
+Returns the pen used for horizontal grid lines. This virtual function may be
+overridden in derived classes in order to change the appearance of individual
+grid line for the given row \arg{row}.
+
+Example: \\
+\\
+\begin{verbatim}
+ // in a grid displaying music notation, use a solid black pen between
+ // octaves (C0=row 127, C1=row 115 etc.)
+ wxPen MidiGrid::GetRowGridLinePen(int row)
+ {
+ if ( row%12 == 7 )
+ return wxPen(*wxBLACK, 1, wxSOLID);
+ else
+ return GetDefaultGridLinePen();
+ }
+\end{verbatim}
+
+
+
+\membersection{wxGrid::GetColGridLinePen}\label{wxgridgetcolgridlinepen}
+
+\func{wxPen}{GetColGridLinePen}{\param{int }{col}}
+
+Returns the pen used for vertical grid lines. This virtual function may be
+overridden in derived classes in order to change the appearance of individual
+grid lines for the given column \arg{col}.
+
+See \helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} for an example.
+
+
\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled}
The sequence of actions begins with the grid object requesting the underlying grid
table to insert new columns. If this is successful the table notifies the grid and the
-grid updates the display. For a default grid (one where you have called
+grid updates the display. For a default grid (one where you have called
\helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
-then you must override
+then you must override
\helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived
table class.
The sequence of actions begins with the grid object requesting the underlying grid
table to insert new rows. If this is successful the table notifies the grid and the
-grid updates the display. For a default grid (one where you have called
+grid updates the display. For a default grid (one where you have called
\helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
-then you must override
+then you must override
\helpref{wxGridTableBase::InsertRows}{wxgridtablebaseinsertrows} in your derived
table class.
The last form is for backward compatibility only.
-See \helpref{wxGridTableBase::CanSetValueAs}{wxgridtablebasecangetvalueas}
+See \helpref{wxGridTableBase::CanSetValueAs}{wxgridtablebasecangetvalueas}
and the \helpref{wxGrid overview}{gridoverview} for more information.
Sets the cell attributes for all cells in the specified column.
-For more information about controlling grid cell attributes see the
-\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
+For more information about controlling grid cell attributes see the
+\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
\helpref{wxGrid classes overview}{gridoverview}.
+\membersection{wxGrid::SetColPos}\label{wxgridsetcolpos}
+
+\func{void}{SetColPos}{\param{int }{colID}, \param{int }{newPos}}
+
+Sets the position of the specified column.
+
+
+
\membersection{wxGrid::SetColSize}\label{wxgridsetcolsize}
\func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}
\membersection{wxGrid::XToCol}\label{wxgridxtocol}
-\func{int}{XToCol}{\param{int }{x}}
+\func{int}{XToCol}{\param{int }{x}, \param{bool }{clipToMinMax = false}}
+
+\wxheading{Parameters}
+\docparam{x}{The x position to evaluate.}
+\docparam{clipToMinMax}{If true, rather than returning wxNOT\_FOUND, it returns either the first or last column depending on whether x is too far to the left or right respectively.}
-Returns the grid column that corresponds to the logical x coordinate. Returns
+\wxheading{Return value}
+The grid column that corresponds to the logical x coordinate. Returns
{\tt wxNOT\_FOUND} if there is no column at the x position.
\func{int}{YToRow}{\param{int }{y}}
-Returns the grid row that corresponds to the logical y coordinate. Returns
+Returns the grid row that corresponds to the logical y coordinate. Returns
{\tt wxNOT\_FOUND} if there is no row at the y position.
projects / wxWidgets.git / blobdiff