Remove use of GetVolumeInformation since it causes long delays on network drives.

[wxWidgets.git] / docs / latex / wx / grid.tex

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index b23da42266119154e665eb108a3e690ad5b04ad3..de383355c7863c5472fc469bb6750a0beb870450 100644 (file)
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -2,7 +2,7 @@
 %% Name:        grid.tex
 %% Purpose:     wxGrid
 %% Author:
 %% Name:        grid.tex
 %% Purpose:     wxGrid
 %% Author:

-%% Modified by:
+%% Modified by: Santiago Palacios

 %% Created:
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets
 %% Created:
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets


@@ -265,6 +265,15 @@ to the client size of the grid window.
 
 
 
 
 
 

+\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::CanDragColSize}\label{wxgridcandragcolsize}
 
 \func{bool}{CanDragColSize}{\void}


@@ -391,6 +400,15 @@ Equivalent to calling EnableCellEditControl(false).
 
 
 
 
 
 

+\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::DisableDragColSize}\label{wxgriddisabledragcolsize}
 
 \func{void}{DisableDragColSize}{\void}


@@ -435,6 +453,14 @@ Enables or disables column sizing by dragging with the mouse.
 
 
 
 
 
 

+\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::EnableDragGridSize}\label{wxgridenabledraggridsize}
 
 \func{void}{EnableDragGridSize}{\param{bool }{enable = true}}


@@ -596,6 +622,13 @@ and the \helpref{wxGrid overview}{gridoverview} for more information.
 
 
 
 
 
 

+\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::GetColLeft}\label{wxgridgetcolleft}
 
 \constfunc{int}{GetColLeft}{\param{int }{col}}


@@ -652,6 +685,14 @@ Get the minimal width of the given column/row.
 
 
 
 
 
 

+\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}}
 \membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
 
 \constfunc{int}{GetColRight}{\param{int }{col}}


@@ -1062,10 +1103,10 @@ used at present.
 
 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
 
 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})
 \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.
 
 \helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived
 table class.
 


@@ -1081,10 +1122,10 @@ present.
 
 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
 
 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})
 \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.
 
 \helpref{wxGridTableBase::InsertRows}{wxgridtablebaseinsertrows} in your derived
 table class.
 


@@ -1438,7 +1479,7 @@ function for those cells that contain string values.
 
 The last form is for backward compatibility only.
 
 
 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.
 
 
 and the \helpref{wxGrid overview}{gridoverview} for more information.
 
 


@@ -1449,8 +1490,8 @@ and the \helpref{wxGrid overview}{gridoverview} for more information.
 
 Sets the cell attributes for all cells in the specified column.
 
 
 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}.
 
 
 \helpref{wxGrid classes overview}{gridoverview}.
 
 


@@ -1543,6 +1584,14 @@ with sizes smaller than the value specified here.
 
 
 
 
 
 

+\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::SetColSize}\label{wxgridsetcolsize}
 
 \func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}


@@ -1877,9 +1926,14 @@ Displays the in-place cell edit control for the current cell.
 
 \membersection{wxGrid::XToCol}\label{wxgridxtocol}
 
 
 \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.
 
 
 {\tt wxNOT\_FOUND} if there is no column at the x position.
 
 


@@ -1906,6 +1960,6 @@ If no row edge is near to this position {\tt wxNOT\_FOUND} is returned.
 
 \func{int}{YToRow}{\param{int }{y}}
 
 
 \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.
 
 {\tt wxNOT\_FOUND} if there is no row at the y position.