added wxTopLevelWindow::RequestUserAttention(); documented it and implemented it...

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

diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex
index f1f4b572537f8cfaf9204f662171e8f989f65ee6..0215e809774d01fb2b065a6b8ebd6d603b0dd6b6 100644 (file)
--- a/docs/latex/wx/gridevt.tex
+++ b/docs/latex/wx/gridevt.tex
@@ -1,89 +1,73 @@
-\section{\class{wxGridEvent}}\label{wxgridevent}
-
-This event class contains information about various grid events.
+\section{\class{wxGridEditorCreatedEvent}}\label{wxgrideditorcreatedevent}

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxNotifyEvent}{wxnotifyevent}\\

 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 

-\wxheading{Include files}
-
-<wx/grid.h>
-

 \wxheading{Event handling}
 
 \wxheading{Event handling}
 

-\input gridevt.inc
+The event handler for the following functions takes a 
+ \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+The ...\_CMD\_... variants also take a window identifier.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\end{twocollist}%

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxGridEvent::wxGridEvent}\label{wxgrideventconstr}
+\membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}

 
 

-\func{}{wxGridEvent}{\void}
+\func{}{wxGridEditorCreatedEvent}{\void}

 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxGridEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj},
- \param{int }{row = -1}, \param{int }{col = -1}, \param{int }{x = -1}, \param{int }{y = -1},
- \param{bool }{sel = TRUE}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE},
- \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}}
-
-\wxheading{Parameters}
-
-\membersection{wxGridEvent::AltDown}\label{wxgrideventaltdown}
-
-\func{bool}{AltDown}{\void}
-
-Returns TRUE if the Alt key was down at the time of the event.
-
-\membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown}
-
-\func{bool}{ControlDown}{\void}
-
-Returns TRUE if the Control key was down at the time of the event.
+\func{}{wxGridEditorCreatedEvent}{\param{int }{id}, \param{wxEventType }{type},
+ \param{wxObject* }{obj}, \param{int }{row}, \param{int }{col}, \param{wxControl* }{ctrl}}

 
 

-\membersection{wxGridEvent::GetCol}\label{wxgrideventgetcol}
+\membersection{wxGridEditorCreatedEvent::GetCol}\label{wxgrideditorcreatedeventgetcol}

 
 \func{int}{GetCol}{\void}
 
 
 \func{int}{GetCol}{\void}
 

-Column at which the event occurred.
+Returns the column at which the event occurred.

 
 

-\membersection{wxGridEvent::GetPosition}\label{wxgrideventgetposition}
+\membersection{wxGridEditorCreatedEvent::GetControl}\label{wxgrideditorcreatedeventgetcontrol}

 
 

-\func{wxPoint}{GetPosition}{\void}
+\func{wxControl*}{GetControl}{\void}

 
 

-Position in pixels at which the event occurred.
+Returns the edit control.

 
 

-\membersection{wxGridEvent::GetRow}\label{wxgrideventgetrow}
+\membersection{wxGridEditorCreatedEvent::GetRow}\label{wxgrideditorcreatedeventgetrow}

 
 \func{int}{GetRow}{\void}
 
 
 \func{int}{GetRow}{\void}
 

-Row at which the evnet occurred.
+Returns the row at which the event occurred.

 
 

-\membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown}
+\membersection{wxGridEditorCreatedEvent::SetCol}\label{wxgrideditorcreatedeventsetcol}

 
 

-\func{bool}{MetaDown}{\void}
+\func{void}{SetCol}{\param{int }{col}}

 
 

-Returns TRUE if the Meta key was down at the time of the event.
+Sets the column at which the event occurred.

 
 

-\membersection{wxGridEvent::Selecting}\label{wxgrideventselecting}
+\membersection{wxGridEditorCreatedEvent::SetControl}\label{wxgrideditorcreatedeventsetcontrol}

 
 

-\func{bool}{Selecting}{\void}
+\func{void}{SetControl}{\param{wxControl* }{ctrl}}

 
 

-Returns TRUE if the user deselected a cell, FALSE if the user
-deselected a cell.
+Sets the edit control.

 
 

-\membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown}
+\membersection{wxGridEditorCreatedEvent::SetRow}\label{wxgrideditorcreatedeventsetrow}

 
 

-\func{bool}{ShiftDown}{\void}
+\func{void}{SetRow}{\param{int }{row}}

 
 

-Returns TRUE if the Shift key was down at the time of the event.
+Sets the row at which the event occurred.

 
 

-\section{\class{wxGridSizeEvent}}\label{wxgridsizeevent}
+\section{\class{wxGridEvent}}\label{wxgridevent}

 
 

-This event class contains information about a row/column resize event.
+This event class contains information about various grid events.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -98,63 +82,71 @@ This event class contains information about a row/column resize event.
 
 \wxheading{Event handling}
 
 
 \wxheading{Event handling}
 

-The event handler for the following functions takes a 
- \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.}
-\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
-\end{twocollist}%
+\input gridevt.inc

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxGridSizeEvent::wxGridSizeEvent}\label{wxgridsizeeventconstr}
+\membersection{wxGridEvent::wxGridEvent}\label{wxgrideventconstr}

 
 

-\func{}{wxGridSizeEvent}{\void}
+\func{}{wxGridEvent}{\void}

 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type},
- \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1},
- \param{int }{y = -1}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE},
- \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}}
+\func{}{wxGridEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj},
+ \param{int }{row = -1}, \param{int }{col = -1}, \param{int }{x = -1}, \param{int }{y = -1},
+ \param{bool }{sel = true}, \param{bool }{control = false}, \param{bool }{shift = false},
+ \param{bool }{alt = false}, \param{bool }{meta = false}}

 
 

-\membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown}
+\wxheading{Parameters}
+
+\membersection{wxGridEvent::AltDown}\label{wxgrideventaltdown}

 
 \func{bool}{AltDown}{\void}
 
 
 \func{bool}{AltDown}{\void}
 

-Returns TRUE if the Alt key was down at the time of the event.
+Returns true if the Alt key was down at the time of the event.

 
 

-\membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown}
+\membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown}

 
 \func{bool}{ControlDown}{\void}
 
 
 \func{bool}{ControlDown}{\void}
 

-Returns TRUE if the Control key was down at the time of the event.
+Returns true if the Control key was down at the time of the event.

 
 

-\membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition}
+\membersection{wxGridEvent::GetCol}\label{wxgrideventgetcol}
+
+\func{int}{GetCol}{\void}
+
+Column at which the event occurred.
+
+\membersection{wxGridEvent::GetPosition}\label{wxgrideventgetposition}

 
 \func{wxPoint}{GetPosition}{\void}
 
 Position in pixels at which the event occurred.
 
 
 \func{wxPoint}{GetPosition}{\void}
 
 Position in pixels at which the event occurred.
 

-\membersection{wxGridSizeEvent::GetRowOrCol}\label{wxgridsizeeventgetroworcol}
+\membersection{wxGridEvent::GetRow}\label{wxgrideventgetrow}

 
 

-\func{int}{GetRowOrCol}{\void}
+\func{int}{GetRow}{\void}

 
 

-Row or column at that was resized.
+Row at which the event occurred.

 
 

-\membersection{wxGridSizeEvent::MetaDown}\label{wxgridsizeeventmetadown}
+\membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown}

 
 \func{bool}{MetaDown}{\void}
 
 
 \func{bool}{MetaDown}{\void}
 

-Returns TRUE if the Meta key was down at the time of the event.
+Returns true if the Meta key was down at the time of the event.

 
 

-\membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown}
+\membersection{wxGridEvent::Selecting}\label{wxgrideventselecting}
+
+\func{bool}{Selecting}{\void}
+
+Returns true if the user deselected a cell, false if the user
+deselected a cell.
+
+\membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown}

 
 \func{bool}{ShiftDown}{\void}
 
 
 \func{bool}{ShiftDown}{\void}
 

-Returns TRUE if the Shift key was down at the time of the event.
+Returns true if the Shift key was down at the time of the event.

 
 \section{\class{wxGridRangeSelectEvent}}\label{wxgridrangeselectevent}
 
 
 \section{\class{wxGridRangeSelectEvent}}\label{wxgridrangeselectevent}
 


@@ -169,10 +161,12 @@ Returns TRUE if the Shift key was down at the time of the event.
 
 The event handler for the following functions takes a 
  \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.
 
 The event handler for the following functions takes a 
  \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.

+The ...\_CMD\_... variants also take a window identifier.

 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.}

+\twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.}

 \end{twocollist}%
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \end{twocollist}%
 
 \latexignore{\rtfignore{\wxheading{Members}}}


@@ -185,21 +179,21 @@ Default constructor.
 
 \func{}{wxGridRangeSelectEvent}{\param{int }{id}, \param{wxEventType }{type},
  \param{wxObject* }{obj}, \param{const wxGridCellCoords\& }{topLeft},
 
 \func{}{wxGridRangeSelectEvent}{\param{int }{id}, \param{wxEventType }{type},
  \param{wxObject* }{obj}, \param{const wxGridCellCoords\& }{topLeft},

- \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = TRUE},
- \param{bool }{control = FALSE}, \param{bool }{shift = FALSE}, \param{bool }{alt = FALSE},
- \param{bool }{meta = FALSE}}
+ \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = true},
+ \param{bool }{control = false}, \param{bool }{shift = false}, \param{bool }{alt = false},
+ \param{bool }{meta = false}}

 
 \membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown}
 
 \func{bool}{AltDown}{\void}
 
 
 \membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown}
 
 \func{bool}{AltDown}{\void}
 

-Returns TRUE if the Alt key was down at the time of the event.
+Returns true if the Alt key was down at the time of the event.

 
 \membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown}
 
 \func{bool}{ControlDown}{\void}
 
 
 \membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown}
 
 \func{bool}{ControlDown}{\void}
 

-Returns TRUE if the Control key was down at the time of the event.
+Returns true if the Control key was down at the time of the event.

 
 \membersection{wxGridRangeSelectEvent::GetBottomRightCoords}\label{wxgridrangeselecteventgetbottomrightcoords}
 
 
 \membersection{wxGridRangeSelectEvent::GetBottomRightCoords}\label{wxgridrangeselecteventgetbottomrightcoords}
 


@@ -217,7 +211,7 @@ Bottom row of the rectangular area that was (de)selected.
 
 \func{int}{GetLeftCol}{\void}
 
 
 \func{int}{GetLeftCol}{\void}
 

-Left column of the rectangualr area that was (de)selected.
+Left column of the rectangular area that was (de)selected.

 
 \membersection{wxGridRangeSelectEvent::GetRightCol}\label{wxgridrangeselecteventgetrightcol}
 
 
 \membersection{wxGridRangeSelectEvent::GetRightCol}\label{wxgridrangeselecteventgetrightcol}
 


@@ -229,7 +223,7 @@ Right column of the rectangular area that was (de)selected.
 
 \func{wxGridCellCoords}{GetTopLeftCoords}{\void}
 
 
 \func{wxGridCellCoords}{GetTopLeftCoords}{\void}
 

-Top left corner of the rectangular area that was (de)delected.
+Top left corner of the rectangular area that was (de)selected.

 
 \membersection{wxGridRangeSelectEvent::GetTopRow}\label{wxgridrangeselecteventgettoprow}
 
 
 \membersection{wxGridRangeSelectEvent::GetTopRow}\label{wxgridrangeselecteventgettoprow}
 


@@ -241,82 +235,95 @@ Top row of the rectangular area that was (de)selected.
 
 \func{bool}{MetaDown}{\void}
 
 
 \func{bool}{MetaDown}{\void}
 

-Returns TRUE if the Meta key was down at the time of the event.
+Returns true if the Meta key was down at the time of the event.

 
 \membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting}
 
 \func{bool}{Selecting}{\void}
 
 
 \membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting}
 
 \func{bool}{Selecting}{\void}
 

-Returns TRUE if the area was selected, FALSE otherwise.
+Returns true if the area was selected, false otherwise.

 
 \membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown}
 
 \func{bool}{ShiftDown}{\void}
 
 
 \membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown}
 
 \func{bool}{ShiftDown}{\void}
 

-Returns TRUE if the Shift key was down at the time of the event.
+Returns true if the Shift key was down at the time of the event.

 
 

-\section{\class{wxGridEditorCreatedEvent}}\label{wxgrideditorcreatedevent}
+\section{\class{wxGridSizeEvent}}\label{wxgridsizeevent}
+
+This event class contains information about a row/column resize event.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

+\helpref{wxNotifyEvent}{wxnotifyevent}\\

 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/grid.h>
+

 \wxheading{Event handling}
 
 The event handler for the following functions takes a 
 \wxheading{Event handling}
 
 The event handler for the following functions takes a 

- \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+ \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
+The ...\_CMD\_... variants also take a window identifier.

 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_SIZE(func)}}{The user resized a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_ROW\_SIZE(func)}}{The user resized a row by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_ROW\_SIZE.}

 \end{twocollist}%
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \end{twocollist}%
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}
+\membersection{wxGridSizeEvent::wxGridSizeEvent}\label{wxgridsizeeventconstr}

 
 

-\func{}{wxGridEditorCreatedEvent}{\void}
+\func{}{wxGridSizeEvent}{\void}

 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxGridEditorCreatedEvent}{\param{int }{id}, \param{wxEventType }{type},
- \param{wxObject* }{obj}, \param{int }{row}, \param{int }{col}, \param{wxControl* }{ctrl}}
+\func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type},
+ \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1},
+ \param{int }{y = -1}, \param{bool }{control = false}, \param{bool }{shift = false},
+ \param{bool }{alt = false}, \param{bool }{meta = false}}

 
 

-\membersection{wxGridEditorCreatedEvent::GetCol}\label{wxgrideditorcreatedeventgetcol}
+\membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown}

 
 

-\func{int}{GetCol}{\void}
+\func{bool}{AltDown}{\void}

 
 

-Returns the column at which the event occurred.
+Returns true if the Alt key was down at the time of the event.

 
 

-\membersection{wxGridEditorCreatedEvent::GetControl}\label{wxgrideditorcreatedeventgetcontrol}
+\membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown}

 
 

-\func{wxControl*}{GetControl}{\void}
+\func{bool}{ControlDown}{\void}

 
 

-Returns the edit control.
+Returns true if the Control key was down at the time of the event.

 
 

-\membersection{wxGridEditorCreatedEvent::GetRow}\label{wxgrideditorcreatedeventgetrow}
+\membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition}

 
 

-\func{int}{GetRow}{\void}
+\func{wxPoint}{GetPosition}{\void}

 
 

-Returns the row at which the event occurred.
+Position in pixels at which the event occurred.

 
 

-\membersection{wxGridEditorCreatedEvent::SetCol}\label{wxgrideditorcreatedeventsetcol}
+\membersection{wxGridSizeEvent::GetRowOrCol}\label{wxgridsizeeventgetroworcol}

 
 

-\func{void}{SetCol}{\param{int }{col}}
+\func{int}{GetRowOrCol}{\void}

 
 

-Sets the column at which the event occurred.
+Row or column at that was resized.

 
 

-\membersection{wxGridEditorCreatedEvent::SetControl}\label{wxgrideditorcreatedeventsetcontrol}
+\membersection{wxGridSizeEvent::MetaDown}\label{wxgridsizeeventmetadown}

 
 

-\func{void}{SetControl}{\param{wxControl* }{ctrl}}
+\func{bool}{MetaDown}{\void}

 
 

-Sets the edit control.
+Returns true if the Meta key was down at the time of the event.

 
 

-\membersection{wxGridEditorCreatedEvent::SetRow}\label{wxgrideditorcreatedeventsetrow}
+\membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown}

 
 

-\func{void}{SetRow}{\param{int }{row}}
+\func{bool}{ShiftDown}{\void}

 
 

-Sets the row at which the event occurred.
+Returns true if the Shift key was down at the time of the event.