]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/menu.tex
Fixes to Cygwin/Mingw32 makefile, manual now compiles wxStaticLine, etc.
[wxWidgets.git] / docs / latex / wx / menu.tex
index 136021b3ed695bda829d7bbe0bef7070fc735d51..fe20490bb578fe3576285b5ade1d891f0b517603 100644 (file)
@@ -41,8 +41,7 @@ this window.
 
 \membersection{wxMenu::wxMenu}\label{wxmenuconstr}
 
-\func{}{wxMenu}{\param{const wxString\& }{title = ""},
-  \param{const wxFunction}{ func = NULL}\param{long}{ style = 0}}
+\func{}{wxMenu}{\param{const wxString\& }{title = ""}, \param{long}{ style = 0}}
 
 Constructs a wxMenu object.
 
@@ -50,24 +49,15 @@ Constructs a wxMenu object.
 
 \docparam{title}{A title for the popup menu: the empty string denotes no title.}
 
-\docparam{func}{A callback function if the menu is used as a popup using \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu}.}
-
 \docparam{style}{If set to \tt{wxMENU_TEAROFF}, the menu will be detachable.}
 
-\pythonnote{The wxPython version of the \tt{wxMenu} constructor
-doesn't accept the callback argument because of reference counting
-issues.  There is a specialized wxMenu constructor called
-\tt{wxPyMenu} which does and can be used for PopupMenus when callbacks
-are needed.  You must retain a reference to the menu while useing it
-otherwise your callback function will get dereferenced when the menu
-does.
-}
 
-\func{}{wxMenu}{\param{long}{ style }}
+\func{}{wxMenu}{\param{long}{ style}}
 
 Constructs a wxMenu object.
 
 \wxheading{Parameters}
+
 \docparam{style}{If set to \tt{wxMENU_TEAROFF}, the menu will be detachable.}
 
 \membersection{wxMenu::\destruct{wxMenu}}
@@ -127,7 +117,6 @@ creation of a menu or menubar.
 \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator}, \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp
 \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem}
 
-
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
@@ -137,7 +126,6 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
-
 \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
 
 \func{void}{AppendSeparator}{\void}
@@ -170,6 +158,24 @@ Checks or unchecks the menu item.
 
 \helpref{wxMenu::IsChecked}{wxmenuischecked}
 
+\membersection{wxMenu::Delete}\label{wxmenudelete}
+
+\func{void}{Delete}{\param{int }{id}}
+
+Deletes the menu item from the menu.
+
+\wxheading{Parameters}
+
+\docparam{id}{Menu item to be deleted.}
+
+\wxheading{Remarks}
+
+Does not delete a sub menu, if any.
+
+\wxheading{See also}
+
+\helpref{wxMenu::FindItemForId}{wxmenufinditemforid}
+
 \membersection{wxMenu::Enable}\label{wxmenuenable}
 
 \func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}}
@@ -198,7 +204,7 @@ Finds the menu item id for a menu item string.
 
 \wxheading{Return value}
 
-Menu item identifier, or -1 if none is found.
+Menu item identifier, or wxNOT_FOUND if none is found.
 
 \wxheading{Remarks}
 
@@ -211,14 +217,15 @@ before matching.
 
 \membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid}
 
-\constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}, \param{wxMenu **}{ menuForItem = NULL}}
+\constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}}
+
+\constfunc{wxMenuItem*}{FindItem}{\param{int}{ id}}
 
 Finds the menu item object associated with the given menu item identifier.
 
 \wxheading{Parameters}
 
 \docparam{id}{Menu item identifier.}
-\docparam{menuForItem}{will be filled with the menu for this item if not NULL.}
 
 \wxheading{Return value}
 
@@ -431,7 +438,6 @@ menu bar.}
 \pythonnote{Only the default constructor is supported in wxPython.
 Use wxMenuBar.Append instead.}
 
-
 \membersection{wxMenuBar::\destruct{wxMenuBar}}
 
 \func{void}{\destruct{wxMenuBar}}{\void}
@@ -515,23 +521,25 @@ Finds the menu item id for a menu name/menu item string pair.
 
 \wxheading{Return value}
 
-The menu item identifier, or -1 if none was found.
+The menu item identifier, or wxNOT_FOUND if none was found.
 
 \wxheading{Remarks}
 
 Any special menu codes are stripped out of source and target strings
 before matching.
 
-\membersection{wxMenuBar::FindItemForId}\label{wxmenubarfinditemforid}
+\membersection{wxMenuBar::FindItem}\label{wxmenubarfinditem}
 
-\constfunc{wxMenuItem *}{FindItemForId}{\param{int}{ id}}
+\constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu}{ **menu = NULL}}
 
-Finds the menu item object associated with the given menu item identifier,
+Finds the menu item object associated with the given menu item identifier.
 
 \wxheading{Parameters}
 
 \docparam{id}{Menu item identifier.}
 
+\docparam{menu}{If not NULL, menu will get set to the associated menu.}
+
 \wxheading{Return value}
 
 The found menu item object, or NULL if one was not found.
@@ -635,6 +643,12 @@ Determines whether an item is enabled.
 
 TRUE if the item was found and is enabled, FALSE otherwise.
 
+\membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh}
+
+\func{void}{Refresh}{\void}
+
+Redraw the menu bar
+
 \membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring}
 
 \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
@@ -691,8 +705,3 @@ Use only after the menubar has been associated with a frame.
 
 \helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop}
 
-
-%%% Local Variables: 
-%%% mode: latex
-%%% TeX-master: t
-%%% End: