Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user

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

diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex
index 2d64a267859aad355103806420d4cd1475dfbf1d..91f540d1ea066646d413583b347d74172790dee5 100644 (file)
--- a/docs/latex/wx/menu.tex
+++ b/docs/latex/wx/menu.tex
@@ -51,7 +51,7 @@ Constructs a wxMenu object.
 
 \docparam{title}{A title for the popup menu: the empty string denotes no title.}
 
 
 \docparam{title}{A title for the popup menu: the empty string denotes no title.}
 

-\docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable.}
+\docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable (wxGTK only).}

 
 \func{}{wxMenu}{\param{long}{ style}}
 
 
 \func{}{wxMenu}{\param{long}{ style}}
 


@@ -59,7 +59,7 @@ Constructs a wxMenu object.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable.}
+\docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable (wxGTK only).}

 
 \membersection{wxMenu::\destruct{wxMenu}}
 
 
 \membersection{wxMenu::\destruct{wxMenu}}
 


@@ -229,32 +229,19 @@ Enables or disables (greys out) a menu item.
 
 Finds the menu item id for a menu item string.
 
 
 Finds the menu item id for a menu item string.
 

-\wxheading{Parameters}
-
-\docparam{itemString}{Menu item string to find.}
-
-\wxheading{Return value}
-
-Menu item identifier, or wxNOT\_FOUND if none is found.
-
-\wxheading{Remarks}
-
-Any special menu codes are stripped out of source and target strings
-before matching.
-
-\wxheading{See also}
-
-\helpref{wxMenu::FindItem}{wxmenufinditem}
-
-\membersection{wxMenu::FindItem}\label{wxmenufinditem}
-

 \constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu **}{menu = NULL}}
 
 Finds the menu item object associated with the given menu item identifier and,
 optionally, the (sub)menu it belongs to.
 
 \constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu **}{menu = NULL}}
 
 Finds the menu item object associated with the given menu item identifier and,
 optionally, the (sub)menu it belongs to.
 

+\perlnote{In wxPerl this method takes just the {\tt id} parameter;
+in scalar context it returns the associated {\tt Wx::MenuItem}, in list
+context it returns a two element list ( item, submenu )}
+

 \wxheading{Parameters}
 
 \wxheading{Parameters}
 

+\docparam{itemString}{Menu item string to find.}
+

 \docparam{id}{Menu item identifier.}
 
 \docparam{menu}{If the pointer is not NULL, it will be filled with the items
 \docparam{id}{Menu item identifier.}
 
 \docparam{menu}{If the pointer is not NULL, it will be filled with the items


@@ -262,13 +249,16 @@ parent menu (if the item was found)}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns the menu item object, or NULL if it is not found.
+First form: menu item identifier, or wxNOT\_FOUND if none is found.

 
 

-\wxheading{See also}
+Second form: returns the menu item object, or NULL if it is not found.
+
+\wxheading{Remarks}

 
 

-\helpref{wxMenu::FindItem}{wxmenufinditem}
+Any special menu codes are stripped out of source and target strings
+before matching.

 
 

-\pythonnote{The name of this method in wxPython is {\tt FindItemById}
+\pythonnote{The name of this method in wxPython is {\tt FindItemById} 

 and it does not support the second parameter.}
 
 \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}
 and it does not support the second parameter.}
 
 \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring}


@@ -499,7 +489,7 @@ by the application frame.
 
 \membersection{wxMenuBar::wxMenuBar}\label{wxmenubarconstr}
 
 
 \membersection{wxMenuBar::wxMenuBar}\label{wxmenubarconstr}
 

-\func{void}{wxMenuBar}{\void}
+\func{void}{wxMenuBar}{\param{long }{style = 0}}

 
 Default constructor.
 
 
 Default constructor.
 


@@ -516,9 +506,14 @@ menu bar.}
 
 \docparam{titles}{An array of title strings. Deallocate this array after creating the menu bar.}
 
 
 \docparam{titles}{An array of title strings. Deallocate this array after creating the menu bar.}
 

+\docparam{style}{If {\tt wxMB\_DOCKABLE} the menu bar can be detached (wxGTK only).}
+

 \pythonnote{Only the default constructor is supported in wxPython.
 Use wxMenuBar.Append instead.}
 
 \pythonnote{Only the default constructor is supported in wxPython.
 Use wxMenuBar.Append instead.}
 

+\perlnote{wxPerl only supports the first contructor: 
+use {\tt Append} instead.}
+

 \membersection{wxMenuBar::\destruct{wxMenuBar}}
 
 \func{void}{\destruct{wxMenuBar}}{\void}
 \membersection{wxMenuBar::\destruct{wxMenuBar}}
 
 \func{void}{\destruct{wxMenuBar}}{\void}


@@ -539,7 +534,7 @@ Adds the item to the end of the menu bar.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE on success, FALSE if an error occured.
+TRUE on success, FALSE if an error occurred.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -596,6 +591,15 @@ Enables or disables a whole menu.
 Only use this when the menu bar has been
 associated with a frame.
 
 Only use this when the menu bar has been
 associated with a frame.
 

+\membersection{wxMenuBar::FindMenu}\label{wxmenubarfindmenu}
+
+\constfunc{int}{FindMenu}{\param{const wxString\& }{title}}
+
+Returns the index of the menu with the given {\it title} or wxNOT\_FOUND if no
+such menu exists in this menubar. The {\it title} parameter may specify either
+the menu title (with accelerator characters, i.e. {\tt "\&File"}) or just the
+menu label ({\tt "File"}) indifferently.
+

 \membersection{wxMenuBar::FindMenuItem}\label{wxmenubarfindmenuitem}
 
 \constfunc{int}{FindMenuItem}{\param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
 \membersection{wxMenuBar::FindMenuItem}\label{wxmenubarfindmenuitem}
 
 \constfunc{int}{FindMenuItem}{\param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}


@@ -704,13 +708,13 @@ Returns the menu at {\it menuIndex} (zero-based).
 
 Returns the number of menus in this menubar.
 
 
 Returns the number of menus in this menubar.
 

-\membersection{wxMenuBar::Insert}{wxmenubarinsert}
+\membersection{wxMenuBar::Insert}\label{wxmenubarinsert}

 
 \func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
 
 Inserts the menu at the given position into the menu bar. Inserting menu at
 
 \func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
 
 Inserts the menu at the given position into the menu bar. Inserting menu at

-position $0$ will insert it in the very beginning of it, inserting at position
-\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling
+position $0$ will insert it in the very beginning of it, inserting at position 
+\helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling 

 \helpref{Append()}{wxmenubarappend}.
 
 \wxheading{Parameters}
 \helpref{Append()}{wxmenubarappend}.
 
 \wxheading{Parameters}


@@ -723,7 +727,7 @@ position $0$ will insert it in the very beginning of it, inserting at position
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE on success, FALSE if an error occured.
+TRUE on success, FALSE if an error occurred.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -768,7 +772,7 @@ Redraw the menu bar
 \func{wxMenu *}{Remove}{\param{size\_t }{pos}}
 
 Removes the menu from the menu bar and returns the menu object - the caller is
 \func{wxMenu *}{Remove}{\param{size\_t }{pos}}
 
 Removes the menu from the menu bar and returns the menu object - the caller is

-reposnbile for deleting it. This function may be used together with
+reposnbile for deleting it. This function may be used together with 

 \helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar
 dynamically.
 
 \helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar
 dynamically.
 


@@ -780,7 +784,7 @@ dynamically.
 
 \func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
 
 
 \func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
 

-Replaces the menu at givenm position with another one.
+Replaces the menu at the given position with another one.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -800,8 +804,6 @@ responsible for deleting it.
 \helpref{wxMenuBar::Insert}{wxmenubarinsert},\rtfsp
 \helpref{wxMenuBar::Remove}{wxmenubarremove}
 
 \helpref{wxMenuBar::Insert}{wxmenubarinsert},\rtfsp
 \helpref{wxMenuBar::Remove}{wxmenubarremove}
 

-\membersection{wxMenuBar::IsChecked}\label{wxmenubarischecked}
-

 \membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring}
 
 \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
 \membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring}
 
 \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}