]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/menu.tex
fixed status bar positioning to work both with and without sizers (patch 1199639...
[wxWidgets.git] / docs / latex / wx / menu.tex
index debd824d6a5252756d76e79a35ffb18aba5582d6..72c93feb33edc483694148d1568a407389ac5b94 100644 (file)
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        menu.tex
+%% Purpose:     wxMenu documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxMenu}}\label{wxmenu}
 
 A menu is a popup (or pull down) list of items, one of which may be
@@ -9,6 +20,13 @@ identify the selection, or to change the menu item in some way. A menu item
 with a special identifier $-1$ is a separator item and doesn't have an
 associated command but just makes a separator line appear in the menu.
 
+{\bf NB:} Please note that {\it wxID\_ABOUT} and {\it wxID\_EXIT} are
+predefined by wxWidgets and have a special meaning since entries
+using these IDs will be taken out of the normal menus under MacOS X
+and will be inserted into the system menu (following the appropriate
+MacOS X interface guideline). On PalmOS {\it wxID\_EXIT} is disabled according
+to Palm OS Companion guidelines.
+
 Menu items may be either normal items, check items or radio items. Normal items
 don't have any special properties while the check items have a boolean flag
 associated to them and they show a checkmark in the menu when the flag is set.
@@ -24,8 +42,8 @@ group is formed by a contiguous range of radio items, i.e. it starts at the
 first item of this kind and ends with the first item of a different kind (or
 the end of the menu). Notice that because the radio groups are defined in terms
 of the item positions inserting or removing the items in the menu containing
-the radio items risks to not work correctly. Finally note that the radio items
-are only supported under Windows and GTK+ currently.
+the radio items risks to not work correctly. Finally note that radio items
+are not supported under Motif.
 
 \wxheading{Allocation strategy}
 
@@ -553,7 +571,7 @@ Inserts a radio item at position $0$.
 
 \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator}
 
-\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}}
+\func{wxMenuItem*}{PrependSeparator}{\void}
 
 Inserts a separator at position $0$.
 
@@ -680,11 +698,11 @@ menu shortcuts may cease to work.
 
 \membersection{wxMenuBar::wxMenuBar}\label{wxmenubarctor}
 
-\func{void}{wxMenuBar}{\param{long }{style = 0}}
+\func{}{wxMenuBar}{\param{long }{style = 0}}
 
 Default constructor.
 
-\func{void}{wxMenuBar}{\param{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}}
+\func{}{wxMenuBar}{\param{size\_t}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}, \param{long }{style = 0}}
 
 Construct a menu bar from arrays of menus and titles.
 
@@ -700,10 +718,10 @@ 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.}
+Use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.}
 
 \perlnote{wxPerl only supports the first constructor: 
-use {\tt Append} instead.}
+use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.}
 
 \membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor}