remove C++ comment

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

diff --git a/docs/latex/wx/treeevt.tex b/docs/latex/wx/treeevt.tex
index 3b325f2d858dc63c516d329920b1ae99b397a92b..4471a2a85b0a6b17564733629df159b89d61acbf 100644 (file)
--- a/docs/latex/wx/treeevt.tex
+++ b/docs/latex/wx/treeevt.tex
@@ -42,6 +42,8 @@ functions that take a wxTreeEvent argument.
 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
 \twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
 is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
 \twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
 is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}

+\twocolitem{{\bf EVT\_TREE\_ITEM\_MENU(id, func)}}{The context menu for the selected item has been requested, either by a right click or by using the menu key.}
+\twocolitem{{\bf EVT\_TREE\_STATE\_IMAGE\_CLICK(id, func)}}{The state image has been clicked. Windows only.}

 \end{twocollist}
 
 \wxheading{See also}
 \end{twocollist}
 
 \wxheading{See also}


@@ -50,37 +52,43 @@ is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxTreeEvent::wxTreeEvent}\label{wxtreeeventctor}
 
 \membersection{wxTreeEvent::wxTreeEvent}\label{wxtreeeventctor}
 

-\func{}{wxTreeEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
+\func{}{wxTreeEvent}{\param{wxEventType }{commandType}, \param{wxTreeCtrl *}{tree}, \param{const wxTreeItemId\&}{item = wxTreeItemId()}}
+
+Constructor, used by wxWidgets itself only.

 
 

-Constructor.

 
 \membersection{wxTreeEvent::GetKeyCode}\label{wxtreeeventgetkeycode}
 
 \constfunc{int}{GetKeyCode}{}
 
 
 \membersection{wxTreeEvent::GetKeyCode}\label{wxtreeeventgetkeycode}
 
 \constfunc{int}{GetKeyCode}{}
 

-Returns the key code if the event was is a key event. Use 
+Returns the key code if the event is a key event. Use 

 \helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
 modifier keys for this event (i.e. Shift or Ctrl).
 
 \helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
 modifier keys for this event (i.e. Shift or Ctrl).
 

+

 \membersection{wxTreeEvent::GetItem}\label{wxtreeeventgetitem}
 
 \constfunc{wxTreeItemId}{GetItem}{}
 
 Returns the item (valid for all events).
 
 \membersection{wxTreeEvent::GetItem}\label{wxtreeeventgetitem}
 
 \constfunc{wxTreeItemId}{GetItem}{}
 
 Returns the item (valid for all events).
 

+

 \membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent}
 
 \constfunc{const wxKeyEvent\&}{GetKeyEvent}{}
 
 Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
 
 \membersection{wxTreeEvent::GetKeyEvent}\label{wxtreeeventgetkeyevent}
 
 \constfunc{const wxKeyEvent\&}{GetKeyEvent}{}
 
 Returns the key event for {\tt EVT\_TREE\_KEY\_DOWN} events.
 

+

 \membersection{wxTreeEvent::GetLabel}\label{wxtreeeventgetlabel}
 
 \constfunc{const wxString\&}{GetLabel}{}
 
 \membersection{wxTreeEvent::GetLabel}\label{wxtreeeventgetlabel}
 
 \constfunc{const wxString\&}{GetLabel}{}
 

-Returns the label if the event was a begin or end edit label event.
+Returns the label if the event is a begin or end edit label event.
+

 
 \membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
 
 
 \membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
 


@@ -88,19 +96,24 @@ Returns the label if the event was a begin or end edit label event.
 
 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
 
 
 Returns the old item index (valid for EVT\_TREE\_ITEM\_CHANGING and CHANGED events)
 

-\membersection{wxTreeEvent::GetPoint()}\label{wxtreeeventgetpoint}
+
+\membersection{wxTreeEvent::GetPoint}\label{wxtreeeventgetpoint}

 
 \constfunc{wxPoint}{GetPoint}{}
 
 
 \constfunc{wxPoint}{GetPoint}{}
 

-Returns the position of the mouse pointer if the event is a drag event.
+Returns the position of the mouse pointer if the event is a drag or menu-context event.
+In both cases the position is in client coordinates - i.e. relative to the wxTreeCtrl
+window (so that you can pass it directly to e.g. \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu}).

 
 

-\membersection{wxTreeEvent::IsEditCancelled()}\label{wxtreeeventiseditcancelled}
+
+\membersection{wxTreeEvent::IsEditCancelled}\label{wxtreeeventiseditcancelled}

 
 \constfunc{bool}{IsEditCancelled}{}
 
 Returns true if the label edit was cancelled. This should be
 called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
 
 
 \constfunc{bool}{IsEditCancelled}{}
 
 Returns true if the label edit was cancelled. This should be
 called from within an EVT\_TREE\_END\_LABEL\_EDIT handler.
 

+

 \membersection{wxTreeEvent::SetToolTip}\label{wxtreeeventsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}
 \membersection{wxTreeEvent::SetToolTip}\label{wxtreeeventsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\&}{ tooltip}}