declared private wxString::operator=(int) to prevent code like "str = 17;" from compiling

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index 00d73b1696a4ca8448e74803f8cc57d48e8eb314..72824ca7c176e1f15e73d801a78bdf58ab8a2ac4 100644 (file)
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -296,7 +296,7 @@ Disables row sizing by dragging with the mouse. Equivalent to passing FALSE to
 \func{void}{EnableCellEditControl}{\param{bool }{enable = TRUE}}
 
 Enables or disables in-place editing of grid cell data. The grid will issue either a
 \func{void}{EnableCellEditControl}{\param{bool }{enable = TRUE}}
 
 Enables or disables in-place editing of grid cell data. The grid will issue either a

-wxEVT_GRID_EDITOR_SHOWN or wxEVT_GRID_EDITOR_HIDDEN event.
+wxEVT\_GRID\_EDITOR\_SHOWN or wxEVT\_GRID\_EDITOR\_HIDDEN event.

 
 \membersection{wxGrid::EnableDragColSize}\label{wxgridenabledragcolsize}
 
 
 \membersection{wxGrid::EnableDragColSize}\label{wxgridenabledragcolsize}
 


@@ -370,8 +370,8 @@ the grid's batch count is greater than zero the display will not be updated.
 Sets the arguments to the horizontal and vertical text alignment values for the
 grid cell at the specified location.
 
 Sets the arguments to the horizontal and vertical text alignment values for the
 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.
+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.

 
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 
 
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 


@@ -863,8 +863,8 @@ deselected; if TRUE the row will be added to the existing selection.
 
 Sets the horizontal and vertial alignment for grid cell text at the specified location.
 
 
 Sets the horizontal and vertial alignment for grid cell text at the specified 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.
+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.

 
 \membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}
 
 
 \membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}
 


@@ -878,7 +878,7 @@ the \helpref{wxGrid overview}{gridoverview} for more information about cell edit
 
 \membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont}
 
 
 \membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont}
 

-\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const }{wxFont\&}}
+\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}}

 
 Sets the font for text in the grid cell at the specified location.
 
 
 Sets the font for text in the grid cell at the specified location.
 


@@ -894,11 +894,11 @@ the \helpref{wxGrid overview}{gridoverview} for more information about cell edit
 
 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
 
 
 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
 

-\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const }{wxColour\&}}
+\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}

 
 \func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}
 
 
 \func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}
 

-\func{void}{SetCellTextColour}{\param{const wxColour\& }{col}}
+\func{void}{SetCellTextColour}{\param{const wxColour\& }{colour}}

 
 Sets the text colour for the grid cell at the specified location.
 
 
 Sets the text colour for the grid cell at the specified location.
 


@@ -965,8 +965,9 @@ with custom data types.
 
 Sets the horizontal and vertical alignment of column label text.
 
 
 Sets the horizontal and vertical alignment of column label text.
 

-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.
+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.

 
 \membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
 
 
 \membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
 


@@ -976,7 +977,7 @@ Sets the height of the column labels.
 
 \membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
 
 
 \membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
 

-\func{void}{SetColLabelValue}{\param{int }{col}, \param{const }{wxString\&}}
+\func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}}

 
 Set the value for the given column label. If you are using a derived grid table you must 
 override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue}
 
 Set the value for the given column label. If you are using a derived grid table you must 
 override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue}


@@ -1011,18 +1012,19 @@ The memory requirements for this could become prohibitive if your grid is very l
 
 Sets the default horizontal and vertial alignment for grid cell text.
 
 
 Sets the default horizontal and vertial alignment for grid cell text.
 

-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.
+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.

 
 \membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
 
 
 \membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
 

-\func{void}{SetDefaultCellBackgroundColour}{\param{const }{wxColour\&}}
+\func{void}{SetDefaultCellBackgroundColour}{\param{const wxColour\&}{ colour}}

 
 Sets the default background colour for grid cells.
 
 \membersection{wxGrid::SetDefaultCellFont}\label{wxgridsetdefaultcellfont}
 
 
 Sets the default background colour for grid cells.
 
 \membersection{wxGrid::SetDefaultCellFont}\label{wxgridsetdefaultcellfont}
 

-\func{void}{SetDefaultCellFont}{\param{const }{wxFont\&}}
+\func{void}{SetDefaultCellFont}{\param{const wxFont\&}{ font}}

 
 Sets the default font to be used for grid cell text.
 
 
 Sets the default font to be used for grid cell text.
 


@@ -1067,25 +1069,25 @@ This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}.
 
 \membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
 
 
 \membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
 

-\func{void}{SetGridLineColour}{\param{const }{wxColour\&}}
+\func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}}

 
 Sets the colour used to draw grid lines.
 
 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
 
 
 Sets the colour used to draw grid lines.
 
 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
 

-\func{void}{SetLabelBackgroundColour}{\param{const }{wxColour\&}}
+\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}}

 
 Sets the background colour for row and column labels.
 
 \membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
 
 
 Sets the background colour for row and column labels.
 
 \membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
 

-\func{void}{SetLabelFont}{\param{const }{wxFont\&}}
+\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}

 
 Sets the font for row and column labels.
 
 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
 
 
 Sets the font for row and column labels.
 
 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
 

-\func{void}{SetLabelTextColour}{\param{const }{wxColour\&}}
+\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}

 
 Sets the colour for row and column label text.
 
 
 Sets the colour for row and column label text.
 


@@ -1110,8 +1112,9 @@ about controlling cell attributes.
 
 Sets the horizontal and vertical alignment of row label text.
 
 
 Sets the horizontal and vertical alignment of row label text.
 

-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.
+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.

 
 \membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
 
 
 \membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
 


@@ -1121,10 +1124,10 @@ Sets the width of the row labels.
 
 \membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
 
 
 \membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
 

-\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const }{wxString\&}}
+\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}

 
 Set the value for the given row label. If you are using a derived grid table you must 
 
 Set the value for the given row label. If you are using a derived grid table you must 

-override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
+override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue} 

 for this to have any effect.
 
 \membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
 for this to have any effect.
 
 \membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}


@@ -1146,13 +1149,14 @@ block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the
 Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
 also be set as the minimal width for the column.
 
 Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
 also be set as the minimal width for the column.
 

-\wxheading{Note}\\
+\wxheading{Note}
+

 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
 The memory requirements for this could become prohibitive if your grid is very large. 
 
 \membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
 
 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
 The memory requirements for this could become prohibitive if your grid is very large. 
 
 \membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
 

-\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{selmode}}
+\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}

 
 Set the selection behaviour of the grid.
 
 
 Set the selection behaviour of the grid.
 


@@ -1160,7 +1164,7 @@ Set the selection behaviour of the grid.
 
 \docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
 
 
 \docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
 

-\docparam(wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
+\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}

 
 \docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
 
 
 \docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
 


@@ -1187,28 +1191,28 @@ Displays the in-place cell edit control for the current cell.
 \func{int}{XToCol}{\param{int }{x}}
 
 Returns the grid column that corresponds to the logical x coordinate. Returns
 \func{int}{XToCol}{\param{int }{x}}
 
 Returns the grid column that corresponds to the logical x coordinate. Returns

-wxNOT_FOUND if there is no column at the x position.
+wxNOT\_FOUND if there is no column at the x position.

 
 \membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
 
 \func{int}{XToEdgeOfCol}{\param{int }{x}}
 
 Returns the column whose right hand edge is close to the given logical x position.
 
 \membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
 
 \func{int}{XToEdgeOfCol}{\param{int }{x}}
 
 Returns the column whose right hand edge is close to the given logical x position.

-If no column edge is near to this position wxNOT_FOUND is returned.
+If no column edge is near to this position wxNOT\_FOUND is returned.

 
 \membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
 
 \func{int}{YToEdgeOfRow}{\param{int }{y}}
 
 Returns the row whose bottom edge is close to the given logical y position.
 
 \membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
 
 \func{int}{YToEdgeOfRow}{\param{int }{y}}
 
 Returns the row whose bottom edge is close to the given logical y position.

-If no row edge is near to this position wxNOT_FOUND is returned.
+If no row edge is near to this position wxNOT\_FOUND is returned.

 
 \membersection{wxGrid::YToRow}\label{wxgridytorow}
 
 \func{int}{YToRow}{\param{int }{y}}
 
 Returns the grid row that corresponds to the logical y coordinate. Returns
 
 \membersection{wxGrid::YToRow}\label{wxgridytorow}
 
 \func{int}{YToRow}{\param{int }{y}}
 
 Returns the grid row that corresponds to the logical y coordinate. Returns

-wxNOT_FOUND if there is no row at the y position.
+wxNOT\_FOUND if there is no row at the y position.

 
 
 
 
 
 


@@ -1264,7 +1268,6 @@ Access or update the selection fore/back colours
 
 Methods for a registry for mapping data types to Renderers/Editors
 
 
 Methods for a registry for mapping data types to Renderers/Editors
 

-

 \membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
 
 \constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}
 \membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
 
 \constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}


@@ -1291,7 +1294,7 @@ Methods for a registry for mapping data types to Renderers/Editors
 
 \func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
 
 
 \func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
 

-grid may occupy more space than needed for its rows/columns, this
+A grid may occupy more space than needed for its rows/columns. This

 function allows to set how big this extra space is
 
 \membersection{wxGrid::wxGrid}\label{wxgridwxgrid}
 function allows to set how big this extra space is
 
 \membersection{wxGrid::wxGrid}\label{wxgridwxgrid}


@@ -1378,9 +1381,6 @@ Backward compatibility.
 
 Backward compatibility.
 
 
 Backward compatibility.
 

-GetRowHeight() is below
-returned num whole rows visible.
-

 \membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
 
 \func{int}{GetViewWidth}{\void}
 \membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
 
 \func{int}{GetViewWidth}{\void}


@@ -1435,7 +1435,7 @@ Returned number of whole cols visible.
 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{col}}
 
 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{col}}
 

-\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const }{wxColour\&}}
+\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}

 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{colour}, \param{int }{row}, \param{int }{col}}
 
 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{colour}, \param{int }{row}, \param{int }{col}}
 


@@ -1573,3 +1573,4 @@ Do we have some place to store attributes in?
 \membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
 
 \constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
 \membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
 
 \constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}

+