X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..4179da8a81ee3110e2a8b5615e1a4f8c8b75a16b:/docs/latex/wx/gridevt.tex diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex index 3594c91d42..0215e80977 100644 --- a/docs/latex/wx/gridevt.tex +++ b/docs/latex/wx/gridevt.tex @@ -10,10 +10,12 @@ 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}}} @@ -92,8 +94,8 @@ 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}} + \param{bool }{sel = true}, \param{bool }{control = false}, \param{bool }{shift = false}, + \param{bool }{alt = false}, \param{bool }{meta = false}} \wxheading{Parameters} @@ -101,13 +103,13 @@ Default constructor. \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{wxGridEvent::ControlDown}\label{wxgrideventcontroldown} \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{wxGridEvent::GetCol}\label{wxgrideventgetcol} @@ -125,26 +127,26 @@ Position in pixels at which the event occurred. \func{int}{GetRow}{\void} -Row at which the evnet occurred. +Row at which the event occurred. \membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown} \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{wxGridEvent::Selecting}\label{wxgrideventselecting} \func{bool}{Selecting}{\void} -Returns TRUE if the user deselected a cell, FALSE if the user +Returns true if the user deselected a cell, false if the user deselected a cell. \membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown} \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} @@ -159,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 ...\_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.} +\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}}} @@ -175,21 +179,21 @@ Default constructor. \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} -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} -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} @@ -207,7 +211,7 @@ Bottom row of the rectangular area that was (de)selected. \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} @@ -219,7 +223,7 @@ Right column of the rectangular area that was (de)selected. \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} @@ -231,19 +235,19 @@ Top row of the rectangular area that was (de)selected. \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} -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} -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{wxGridSizeEvent}}\label{wxgridsizeevent} @@ -264,11 +268,14 @@ This event class contains information about a row/column resize event. The event handler for the following functions takes a \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter. +The ...\_CMD\_... variants also take a window identifier. \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.} +\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}}} @@ -281,20 +288,20 @@ 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}} + \param{int }{y = -1}, \param{bool }{control = false}, \param{bool }{shift = false}, + \param{bool }{alt = false}, \param{bool }{meta = false}} \membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown} \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} \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} @@ -312,11 +319,11 @@ Row or column at that was resized. \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} \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.