| 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: menu.tex |
| 3 | %% Purpose: wxMenu documentation |
| 4 | %% Author: wxWidgets Team |
| 5 | %% Modified by: |
| 6 | %% Created: |
| 7 | %% RCS-ID: $Id$ |
| 8 | %% Copyright: (c) wxWidgets Team |
| 9 | %% License: wxWindows license |
| 10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 11 | |
| 12 | \section{\class{wxMenu}}\label{wxmenu} |
| 13 | |
| 14 | A menu is a popup (or pull down) list of items, one of which may be |
| 15 | selected before the menu goes away (clicking elsewhere dismisses the |
| 16 | menu). Menus may be used to construct either menu bars or popup menus. |
| 17 | |
| 18 | A menu item has an integer ID associated with it which can be used to |
| 19 | identify the selection, or to change the menu item in some way. A menu item |
| 20 | with a special identifier $-1$ is a separator item and doesn't have an |
| 21 | associated command but just makes a separator line appear in the menu. |
| 22 | |
| 23 | {\bf NB:} Please note that {\it wxID\_ABOUT} and {\it wxID\_EXIT} are |
| 24 | predefined by wxWidgets and have a special meaning since entries |
| 25 | using these IDs will be taken out of the normal menus under MacOS X |
| 26 | and will be inserted into the system menu (following the appropriate |
| 27 | MacOS X interface guideline). On PalmOS {\it wxID\_EXIT} is disabled according |
| 28 | to Palm OS Companion guidelines. |
| 29 | |
| 30 | Menu items may be either normal items, check items or radio items. Normal items |
| 31 | don't have any special properties while the check items have a boolean flag |
| 32 | associated to them and they show a checkmark in the menu when the flag is set. |
| 33 | wxWidgets automatically toggles the flag value when the item is clicked and its |
| 34 | value may be retrieved using either \helpref{IsChecked}{wxmenuischecked} method |
| 35 | of wxMenu or wxMenuBar itself or by using |
| 36 | \helpref{wxEvent::IsChecked}{wxcommandeventischecked} when you get the menu |
| 37 | notification for the item in question. |
| 38 | |
| 39 | The radio items are similar to the check items except that all the other items |
| 40 | in the same radio group are unchecked when a radio item is checked. The radio |
| 41 | group is formed by a contiguous range of radio items, i.e. it starts at the |
| 42 | first item of this kind and ends with the first item of a different kind (or |
| 43 | the end of the menu). Notice that because the radio groups are defined in terms |
| 44 | of the item positions inserting or removing the items in the menu containing |
| 45 | the radio items risks to not work correctly. Finally note that radio items |
| 46 | are not supported under Motif. |
| 47 | |
| 48 | \wxheading{Allocation strategy} |
| 49 | |
| 50 | All menus except the popup ones must be created on the heap. All menus |
| 51 | attached to a menubar or to another menu will be deleted by their parent when |
| 52 | it is deleted. As the frame menubar is deleted by the frame itself, it means |
| 53 | that normally all menus used are deleted automatically. |
| 54 | |
| 55 | \wxheading{Derived from} |
| 56 | |
| 57 | \helpref{wxEvtHandler}{wxevthandler}\\ |
| 58 | \helpref{wxObject}{wxobject} |
| 59 | |
| 60 | \wxheading{Include files} |
| 61 | |
| 62 | <wx/menu.h> |
| 63 | |
| 64 | \wxheading{Event handling} |
| 65 | |
| 66 | If the menu is part of a menubar, then \helpref{wxMenuBar}{wxmenubar} event processing is used. |
| 67 | |
| 68 | With a popup menu, there is a variety of ways to handle a menu selection event |
| 69 | (wxEVT\_COMMAND\_MENU\_SELECTED). |
| 70 | |
| 71 | \begin{enumerate}\itemsep=0pt |
| 72 | \item Derive a new class from wxMenu and define event table entries using the EVT\_MENU macro. |
| 73 | \item Set a new event handler for wxMenu, using an object whose class has EVT\_MENU entries. |
| 74 | \item Provide EVT\_MENU handlers in the window which pops up the menu, or in an ancestor of |
| 75 | this window. |
| 76 | \item Define a callback of type wxFunction, which you pass to the wxMenu constructor. |
| 77 | The callback takes a reference to the menu, and a reference to a |
| 78 | \helpref{wxCommandEvent}{wxcommandevent}. This method is deprecated and should |
| 79 | not be used in the new code, it is provided for backwards compatibility only. |
| 80 | \end{enumerate} |
| 81 | |
| 82 | \wxheading{See also} |
| 83 | |
| 84 | \helpref{wxMenuBar}{wxmenubar}, \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu},\rtfsp |
| 85 | \helpref{Event handling overview}{eventhandlingoverview},\rtfsp |
| 86 | \helpref{wxFileHistory (most recently used files menu)}{wxfilehistory} |
| 87 | |
| 88 | |
| 89 | |
| 90 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 91 | |
| 92 | |
| 93 | \membersection{wxMenu::wxMenu}\label{wxmenuctor} |
| 94 | |
| 95 | \func{}{wxMenu}{\param{const wxString\& }{title = ""}, \param{long}{ style = 0}} |
| 96 | |
| 97 | Constructs a wxMenu object. |
| 98 | |
| 99 | \wxheading{Parameters} |
| 100 | |
| 101 | \docparam{title}{A title for the popup menu: the empty string denotes no title.} |
| 102 | |
| 103 | \docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable (wxGTK only).} |
| 104 | |
| 105 | \func{}{wxMenu}{\param{long}{ style}} |
| 106 | |
| 107 | Constructs a wxMenu object. |
| 108 | |
| 109 | \wxheading{Parameters} |
| 110 | |
| 111 | \docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable (wxGTK only).} |
| 112 | |
| 113 | |
| 114 | \membersection{wxMenu::\destruct{wxMenu}}\label{wxmenudtor} |
| 115 | |
| 116 | \func{}{\destruct{wxMenu}}{\void} |
| 117 | |
| 118 | Destructor, destroying the menu. |
| 119 | |
| 120 | Note: under Motif, a popup menu must have a valid parent (the window |
| 121 | it was last popped up on) when being destroyed. Therefore, make sure |
| 122 | you delete or re-use the popup menu {\it before} destroying the |
| 123 | parent window. Re-use in this context means popping up the menu on |
| 124 | a different window from last time, which causes an implicit destruction |
| 125 | and recreation of internal data structures. |
| 126 | |
| 127 | |
| 128 | \membersection{wxMenu::Append}\label{wxmenuappend} |
| 129 | |
| 130 | \func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp |
| 131 | \param{wxItemKind}{ kind = wxITEM\_NORMAL}} |
| 132 | |
| 133 | Adds a string item to the end of the menu. |
| 134 | |
| 135 | \func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp |
| 136 | \param{const wxString\& }{helpString = ""}} |
| 137 | |
| 138 | Adds a pull-right submenu to the end of the menu. Append the submenu to the parent |
| 139 | menu {\it after} you have added your menu items, or accelerators may not be |
| 140 | registered properly. |
| 141 | |
| 142 | \func{wxMenuItem*}{Append}{\param{wxMenuItem*}{ menuItem}} |
| 143 | |
| 144 | Adds a menu item object. This is the most generic variant of Append() method |
| 145 | because it may be used for both items (including separators) and submenus and |
| 146 | because you can also specify various extra properties of a menu item this way, |
| 147 | such as bitmaps and fonts. |
| 148 | |
| 149 | \wxheading{Parameters} |
| 150 | |
| 151 | \docparam{id}{The menu command identifier.} |
| 152 | |
| 153 | \docparam{item}{The string to appear on the menu item.} |
| 154 | |
| 155 | \docparam{menu}{Pull-right submenu.} |
| 156 | |
| 157 | \docparam{kind}{May be {\tt wxITEM\_SEPARATOR}, {\tt wxITEM\_NORMAL}, |
| 158 | {\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}} |
| 159 | |
| 160 | \docparam{helpString}{An optional help string associated with the item. |
| 161 | By default, the handler for the wxEVT\_MENU\_HIGHLIGHT event displays |
| 162 | this string in the status line.} |
| 163 | |
| 164 | \docparam{menuItem}{A menuitem object. It will be owned by the wxMenu object after this function |
| 165 | is called, so do not delete it yourself.} |
| 166 | |
| 167 | \wxheading{Remarks} |
| 168 | |
| 169 | This command can be used after the menu has been shown, as well as on initial |
| 170 | creation of a menu or menubar. |
| 171 | |
| 172 | The {\it item} string for the normal menu items (not submenus or separators) |
| 173 | may include the accelerator which can be used to activate the menu item |
| 174 | from keyboard. The accelerator string follows the item label and is separated |
| 175 | from it by a {\tt TAB} character ({\tt '$\backslash$t'}). Its general syntax is |
| 176 | any combination of {\tt "CTRL"}, {\tt "ALT"} and {\tt "SHIFT"} strings (case |
| 177 | doesn't matter) separated by either {\tt '-'} or {\tt '+'} characters and |
| 178 | followed by the accelerator itself. The accelerator may be any alphanumeric |
| 179 | character, any function key (from {\tt F1} to {\tt F12}) or one of the special |
| 180 | characters listed in the table below (again, case doesn't matter): |
| 181 | |
| 182 | \begin{twocollist}\itemsep=0pt |
| 183 | \twocolitem{{\tt DEL} or {\tt DELETE}}{Delete key} |
| 184 | \twocolitem{{\tt INS} or {\tt INSERT}}{Insert key} |
| 185 | \twocolitem{{\tt ENTER} or {\tt RETURN}}{Enter key} |
| 186 | \twocolitem{{\tt PGUP}}{PageUp key} |
| 187 | \twocolitem{{\tt PGDN}}{PageDown key} |
| 188 | \twocolitem{{\tt LEFT}}{Left cursor arrow key} |
| 189 | \twocolitem{{\tt RIGHT}}{Right cursor arrow key} |
| 190 | \twocolitem{{\tt UP}}{Up cursor arrow key} |
| 191 | \twocolitem{{\tt DOWN}}{Down cursor arrow key} |
| 192 | \twocolitem{{\tt HOME}}{Home key} |
| 193 | \twocolitem{{\tt END}}{End key} |
| 194 | \twocolitem{{\tt SPACE}}{Space} |
| 195 | \twocolitem{{\tt TAB}}{Tab key} |
| 196 | \twocolitem{{\tt ESC} or {\tt ESCAPE}}{Escape key (Windows only)} |
| 197 | \end{twocollist} |
| 198 | |
| 199 | \wxheading{See also} |
| 200 | |
| 201 | \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator},\rtfsp |
| 202 | \helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem},\rtfsp |
| 203 | \helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem},\rtfsp |
| 204 | \helpref{wxMenu::AppendSubMenu}{wxmenuappendsubmenu},\rtfsp |
| 205 | \helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp |
| 206 | \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp |
| 207 | \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem} |
| 208 | |
| 209 | \pythonnote{In place of a single overloaded method name, wxPython |
| 210 | implements the following methods: |
| 211 | |
| 212 | \indented{2cm}{\begin{twocollist} |
| 213 | \twocolitem{{\bf Append(id, string, helpStr="", checkable=false)}}{} |
| 214 | \twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{} |
| 215 | \twocolitem{{\bf AppendItem(aMenuItem)}}{} |
| 216 | \end{twocollist}} |
| 217 | } |
| 218 | |
| 219 | |
| 220 | \membersection{wxMenu::AppendCheckItem}\label{wxmenuappendcheckitem} |
| 221 | |
| 222 | \func{wxMenuItem*}{AppendCheckItem}{\param{int}{ id},\rtfsp |
| 223 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 224 | |
| 225 | Adds a checkable item to the end of the menu. |
| 226 | |
| 227 | \wxheading{See also} |
| 228 | |
| 229 | \helpref{wxMenu::Append}{wxmenuappend},\rtfsp |
| 230 | \helpref{wxMenu::InsertCheckItem}{wxmenuinsertcheckitem} |
| 231 | |
| 232 | |
| 233 | \membersection{wxMenu::AppendRadioItem}\label{wxmenuappendradioitem} |
| 234 | |
| 235 | \func{wxMenuItem*}{AppendRadioItem}{\param{int}{ id},\rtfsp |
| 236 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 237 | |
| 238 | Adds a radio item to the end of the menu. All consequent radio items form a |
| 239 | group and when an item in the group is checked, all the others are |
| 240 | automatically unchecked. |
| 241 | |
| 242 | \wxheading{See also} |
| 243 | |
| 244 | \helpref{wxMenu::Append}{wxmenuappend},\rtfsp |
| 245 | \helpref{wxMenu::InsertRadioItem}{wxmenuinsertradioitem} |
| 246 | |
| 247 | |
| 248 | \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator} |
| 249 | |
| 250 | \func{wxMenuItem*}{AppendSeparator}{\void} |
| 251 | |
| 252 | Adds a separator to the end of the menu. |
| 253 | |
| 254 | \wxheading{See also} |
| 255 | |
| 256 | \helpref{wxMenu::Append}{wxmenuappend},\rtfsp |
| 257 | \helpref{wxMenu::InsertSeparator}{wxmenuinsertseparator} |
| 258 | |
| 259 | |
| 260 | \membersection{wxMenu::AppendSubMenu}\label{wxmenuappendsubmenu} |
| 261 | |
| 262 | \func{wxMenuItem *}{AppendSubMenu}{\param{wxMenu *}{submenu}, \param{const wxString\& }{text}, \param{const wxString\& }{help = wxEmptyString}} |
| 263 | |
| 264 | Adds the given \arg{submenu} to this menu. \arg{text} is the text shown in the |
| 265 | menu for it and \arg{help} is the help string shown in the status bar when the |
| 266 | submenu item is selected. |
| 267 | |
| 268 | |
| 269 | \membersection{wxMenu::Break}\label{wxmenubreak} |
| 270 | |
| 271 | \func{void}{Break}{\void} |
| 272 | |
| 273 | Inserts a break in a menu, causing the next appended item to appear in a new column. |
| 274 | |
| 275 | |
| 276 | \membersection{wxMenu::Check}\label{wxmenucheck} |
| 277 | |
| 278 | \func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}} |
| 279 | |
| 280 | Checks or unchecks the menu item. |
| 281 | |
| 282 | \wxheading{Parameters} |
| 283 | |
| 284 | \docparam{id}{The menu item identifier.} |
| 285 | |
| 286 | \docparam{check}{If true, the item will be checked, otherwise it will be unchecked.} |
| 287 | |
| 288 | \wxheading{See also} |
| 289 | |
| 290 | \helpref{wxMenu::IsChecked}{wxmenuischecked} |
| 291 | |
| 292 | |
| 293 | \membersection{wxMenu::Delete}\label{wxmenudelete} |
| 294 | |
| 295 | \func{void}{Delete}{\param{int }{id}} |
| 296 | |
| 297 | \func{void}{Delete}{\param{wxMenuItem *}{item}} |
| 298 | |
| 299 | Deletes the menu item from the menu. If the item is a submenu, it will |
| 300 | {\bf not} be deleted. Use \helpref{Destroy}{wxmenudestroy} if you want to |
| 301 | delete a submenu. |
| 302 | |
| 303 | \wxheading{Parameters} |
| 304 | |
| 305 | \docparam{id}{Id of the menu item to be deleted.} |
| 306 | |
| 307 | \docparam{item}{Menu item to be deleted.} |
| 308 | |
| 309 | \wxheading{See also} |
| 310 | |
| 311 | \helpref{wxMenu::FindItem}{wxmenufinditem},\rtfsp |
| 312 | \helpref{wxMenu::Destroy}{wxmenudestroy},\rtfsp |
| 313 | \helpref{wxMenu::Remove}{wxmenuremove} |
| 314 | |
| 315 | |
| 316 | \membersection{wxMenu::Destroy}\label{wxmenudestroy} |
| 317 | |
| 318 | \func{void}{Destroy}{\param{int }{id}} |
| 319 | |
| 320 | \func{void}{Destroy}{\param{wxMenuItem *}{item}} |
| 321 | |
| 322 | Deletes the menu item from the menu. If the item is a submenu, it will |
| 323 | be deleted. Use \helpref{Remove}{wxmenuremove} if you want to keep the submenu |
| 324 | (for example, to reuse it later). |
| 325 | |
| 326 | \wxheading{Parameters} |
| 327 | |
| 328 | \docparam{id}{Id of the menu item to be deleted.} |
| 329 | |
| 330 | \docparam{item}{Menu item to be deleted.} |
| 331 | |
| 332 | \wxheading{See also} |
| 333 | |
| 334 | \helpref{wxMenu::FindItem}{wxmenufinditem},\rtfsp |
| 335 | \helpref{wxMenu::Deletes}{wxmenudelete},\rtfsp |
| 336 | \helpref{wxMenu::Remove}{wxmenuremove} |
| 337 | |
| 338 | |
| 339 | \membersection{wxMenu::Enable}\label{wxmenuenable} |
| 340 | |
| 341 | \func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}} |
| 342 | |
| 343 | Enables or disables (greys out) a menu item. |
| 344 | |
| 345 | \wxheading{Parameters} |
| 346 | |
| 347 | \docparam{id}{The menu item identifier.} |
| 348 | |
| 349 | \docparam{enable}{true to enable the menu item, false to disable it.} |
| 350 | |
| 351 | \wxheading{See also} |
| 352 | |
| 353 | \helpref{wxMenu::IsEnabled}{wxmenuisenabled} |
| 354 | |
| 355 | |
| 356 | \membersection{wxMenu::FindItem}\label{wxmenufinditem} |
| 357 | |
| 358 | \constfunc{int}{FindItem}{\param{const wxString\& }{itemString}} |
| 359 | |
| 360 | Finds the menu item id for a menu item string. |
| 361 | |
| 362 | \constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu **}{menu = NULL}} |
| 363 | |
| 364 | Finds the menu item object associated with the given menu item identifier and, |
| 365 | optionally, the (sub)menu it belongs to. |
| 366 | |
| 367 | \perlnote{In wxPerl this method takes just the {\tt id} parameter; |
| 368 | in scalar context it returns the associated {\tt Wx::MenuItem}, in list |
| 369 | context it returns a 2-element list {\tt ( item, submenu )}} |
| 370 | |
| 371 | \wxheading{Parameters} |
| 372 | |
| 373 | \docparam{itemString}{Menu item string to find.} |
| 374 | |
| 375 | \docparam{id}{Menu item identifier.} |
| 376 | |
| 377 | \docparam{menu}{If the pointer is not NULL, it will be filled with the item's |
| 378 | parent menu (if the item was found)} |
| 379 | |
| 380 | \wxheading{Return value} |
| 381 | |
| 382 | First form: menu item identifier, or {\tt wxNOT\_FOUND} if none is found. |
| 383 | |
| 384 | Second form: returns the menu item object, or NULL if it is not found. |
| 385 | |
| 386 | \wxheading{Remarks} |
| 387 | |
| 388 | Any special menu codes are stripped out of source and target strings |
| 389 | before matching. |
| 390 | |
| 391 | \pythonnote{The name of this method in wxPython is {\tt FindItemById} |
| 392 | and it does not support the second parameter.} |
| 393 | |
| 394 | |
| 395 | \membersection{wxMenu::FindItemByPosition}\label{wxmenufinditembyposition} |
| 396 | |
| 397 | \constfunc{wxMenuItem*}{FindItemByPosition}{\param{size\_t }{position}} |
| 398 | |
| 399 | Returns the wxMenuItem given a position in the menu. |
| 400 | |
| 401 | |
| 402 | \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring} |
| 403 | |
| 404 | \constfunc{wxString}{GetHelpString}{\param{int}{ id}} |
| 405 | |
| 406 | Returns the help string associated with a menu item. |
| 407 | |
| 408 | \wxheading{Parameters} |
| 409 | |
| 410 | \docparam{id}{The menu item identifier.} |
| 411 | |
| 412 | \wxheading{Return value} |
| 413 | |
| 414 | The help string, or the empty string if there is no help string or the |
| 415 | item was not found. |
| 416 | |
| 417 | \wxheading{See also} |
| 418 | |
| 419 | \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenu::Append}{wxmenuappend} |
| 420 | |
| 421 | |
| 422 | \membersection{wxMenu::GetLabel}\label{wxmenugetlabel} |
| 423 | |
| 424 | \constfunc{wxString}{GetLabel}{\param{int}{ id}} |
| 425 | |
| 426 | Returns a menu item label. |
| 427 | |
| 428 | \wxheading{Parameters} |
| 429 | |
| 430 | \docparam{id}{The menu item identifier.} |
| 431 | |
| 432 | \wxheading{Return value} |
| 433 | |
| 434 | The item label, or the empty string if the item was not found. |
| 435 | |
| 436 | \wxheading{See also} |
| 437 | |
| 438 | \helpref{wxMenu::SetLabel}{wxmenusetlabel} |
| 439 | |
| 440 | |
| 441 | \membersection{wxMenu::GetMenuItemCount}\label{wxmenugetmenuitemcount} |
| 442 | |
| 443 | \constfunc{size\_t}{GetMenuItemCount}{\void} |
| 444 | |
| 445 | Returns the number of items in the menu. |
| 446 | |
| 447 | |
| 448 | \membersection{wxMenu::GetMenuItems}\label{wxmenugetmenuitems} |
| 449 | |
| 450 | \constfunc{wxMenuItemList\&}{GetMenuItems}{\void} |
| 451 | |
| 452 | Returns the list of items in the menu. wxMenuItemList is a pseudo-template |
| 453 | list class containing wxMenuItem pointers. |
| 454 | |
| 455 | |
| 456 | \membersection{wxMenu::GetTitle}\label{wxmenugettitle} |
| 457 | |
| 458 | \constfunc{wxString}{GetTitle}{\void} |
| 459 | |
| 460 | Returns the title of the menu. |
| 461 | |
| 462 | \wxheading{Remarks} |
| 463 | |
| 464 | This is relevant only to popup menus, use |
| 465 | \helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop} for the menus in the |
| 466 | menubar. |
| 467 | |
| 468 | \wxheading{See also} |
| 469 | |
| 470 | \helpref{wxMenu::SetTitle}{wxmenusettitle} |
| 471 | |
| 472 | |
| 473 | \membersection{wxMenu::Insert}\label{wxmenuinsert} |
| 474 | |
| 475 | \func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}} |
| 476 | |
| 477 | \func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp |
| 478 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp |
| 479 | \param{wxItemKind}{ kind = wxITEM\_NORMAL}} |
| 480 | |
| 481 | Inserts the given {\it item} before the position {\it pos}. Inserting the item |
| 482 | at position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same |
| 483 | as appending it. |
| 484 | |
| 485 | \wxheading{See also} |
| 486 | |
| 487 | \helpref{wxMenu::Append}{wxmenuappend},\rtfsp |
| 488 | \helpref{wxMenu::Prepend}{wxmenuprepend} |
| 489 | |
| 490 | |
| 491 | \membersection{wxMenu::InsertCheckItem}\label{wxmenuinsertcheckitem} |
| 492 | |
| 493 | \func{wxMenuItem*}{InsertCheckItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp |
| 494 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 495 | |
| 496 | Inserts a checkable item at the given position. |
| 497 | |
| 498 | \wxheading{See also} |
| 499 | |
| 500 | \helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp |
| 501 | \helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem} |
| 502 | |
| 503 | |
| 504 | \membersection{wxMenu::InsertRadioItem}\label{wxmenuinsertradioitem} |
| 505 | |
| 506 | \func{wxMenuItem*}{InsertRadioItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp |
| 507 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 508 | |
| 509 | Inserts a radio item at the given position. |
| 510 | |
| 511 | \wxheading{See also} |
| 512 | |
| 513 | \helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp |
| 514 | \helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem} |
| 515 | |
| 516 | |
| 517 | \membersection{wxMenu::InsertSeparator}\label{wxmenuinsertseparator} |
| 518 | |
| 519 | \func{wxMenuItem*}{InsertSeparator}{\param{size\_t }{pos}} |
| 520 | |
| 521 | Inserts a separator at the given position. |
| 522 | |
| 523 | \wxheading{See also} |
| 524 | |
| 525 | \helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp |
| 526 | \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator} |
| 527 | |
| 528 | |
| 529 | \membersection{wxMenu::IsChecked}\label{wxmenuischecked} |
| 530 | |
| 531 | \constfunc{bool}{IsChecked}{\param{int}{ id}} |
| 532 | |
| 533 | Determines whether a menu item is checked. |
| 534 | |
| 535 | \wxheading{Parameters} |
| 536 | |
| 537 | \docparam{id}{The menu item identifier.} |
| 538 | |
| 539 | \wxheading{Return value} |
| 540 | |
| 541 | true if the menu item is checked, false otherwise. |
| 542 | |
| 543 | \wxheading{See also} |
| 544 | |
| 545 | \helpref{wxMenu::Check}{wxmenucheck} |
| 546 | |
| 547 | |
| 548 | \membersection{wxMenu::IsEnabled}\label{wxmenuisenabled} |
| 549 | |
| 550 | \constfunc{bool}{IsEnabled}{\param{int}{ id}} |
| 551 | |
| 552 | Determines whether a menu item is enabled. |
| 553 | |
| 554 | \wxheading{Parameters} |
| 555 | |
| 556 | \docparam{id}{The menu item identifier.} |
| 557 | |
| 558 | \wxheading{Return value} |
| 559 | |
| 560 | true if the menu item is enabled, false otherwise. |
| 561 | |
| 562 | \wxheading{See also} |
| 563 | |
| 564 | \helpref{wxMenu::Enable}{wxmenuenable} |
| 565 | |
| 566 | |
| 567 | \membersection{wxMenu::Prepend}\label{wxmenuprepend} |
| 568 | |
| 569 | \func{wxMenuItem*}{Prepend}{\param{wxMenuItem *}{item}} |
| 570 | |
| 571 | \func{wxMenuItem*}{Prepend}{\param{int}{ id},\rtfsp |
| 572 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp |
| 573 | \param{wxItemKind}{ kind = wxITEM\_NORMAL}} |
| 574 | |
| 575 | Inserts the given {\it item} at position $0$, i.e. before all the other |
| 576 | existing items. |
| 577 | |
| 578 | \wxheading{See also} |
| 579 | |
| 580 | \helpref{wxMenu::Append}{wxmenuappend},\rtfsp |
| 581 | \helpref{wxMenu::Insert}{wxmenuinsert} |
| 582 | |
| 583 | |
| 584 | \membersection{wxMenu::PrependCheckItem}\label{wxmenuprependcheckitem} |
| 585 | |
| 586 | \func{wxMenuItem*}{PrependCheckItem}{\param{int}{ id},\rtfsp |
| 587 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 588 | |
| 589 | Inserts a checkable item at position $0$. |
| 590 | |
| 591 | \wxheading{See also} |
| 592 | |
| 593 | \helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp |
| 594 | \helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem} |
| 595 | |
| 596 | |
| 597 | \membersection{wxMenu::PrependRadioItem}\label{wxmenuprependradioitem} |
| 598 | |
| 599 | \func{wxMenuItem*}{PrependRadioItem}{\param{int}{ id},\rtfsp |
| 600 | \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} |
| 601 | |
| 602 | Inserts a radio item at position $0$. |
| 603 | |
| 604 | \wxheading{See also} |
| 605 | |
| 606 | \helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp |
| 607 | \helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem} |
| 608 | |
| 609 | |
| 610 | \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator} |
| 611 | |
| 612 | \func{wxMenuItem*}{PrependSeparator}{\void} |
| 613 | |
| 614 | Inserts a separator at position $0$. |
| 615 | |
| 616 | \wxheading{See also} |
| 617 | |
| 618 | \helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp |
| 619 | \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator} |
| 620 | |
| 621 | |
| 622 | \membersection{wxMenu::Remove}\label{wxmenuremove} |
| 623 | |
| 624 | \func{wxMenuItem *}{Remove}{\param{int }{id}} |
| 625 | |
| 626 | \func{wxMenuItem *}{Remove}{\param{wxMenuItem *}{item}} |
| 627 | |
| 628 | Removes the menu item from the menu but doesn't delete the associated C++ |
| 629 | object. This allows to reuse the same item later by adding it back to the menu |
| 630 | (especially useful with submenus). |
| 631 | |
| 632 | \wxheading{Parameters} |
| 633 | |
| 634 | \docparam{id}{The identifier of the menu item to remove.} |
| 635 | |
| 636 | \docparam{item}{The menu item to remove.} |
| 637 | |
| 638 | \wxheading{Return value} |
| 639 | |
| 640 | The item which was detached from the menu. |
| 641 | |
| 642 | |
| 643 | \membersection{wxMenu::SetHelpString}\label{wxmenusethelpstring} |
| 644 | |
| 645 | \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}} |
| 646 | |
| 647 | Sets an item's help string. |
| 648 | |
| 649 | \wxheading{Parameters} |
| 650 | |
| 651 | \docparam{id}{The menu item identifier.} |
| 652 | |
| 653 | \docparam{helpString}{The help string to set.} |
| 654 | |
| 655 | \wxheading{See also} |
| 656 | |
| 657 | \helpref{wxMenu::GetHelpString}{wxmenugethelpstring} |
| 658 | |
| 659 | |
| 660 | \membersection{wxMenu::SetLabel}\label{wxmenusetlabel} |
| 661 | |
| 662 | \func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}} |
| 663 | |
| 664 | Sets the label of a menu item. |
| 665 | |
| 666 | \wxheading{Parameters} |
| 667 | |
| 668 | \docparam{id}{The menu item identifier.} |
| 669 | |
| 670 | \docparam{label}{The menu item label to set.} |
| 671 | |
| 672 | \wxheading{See also} |
| 673 | |
| 674 | \helpref{wxMenu::Append}{wxmenuappend}, \helpref{wxMenu::GetLabel}{wxmenugetlabel} |
| 675 | |
| 676 | |
| 677 | \membersection{wxMenu::SetTitle}\label{wxmenusettitle} |
| 678 | |
| 679 | \func{void}{SetTitle}{\param{const wxString\& }{title}} |
| 680 | |
| 681 | Sets the title of the menu. |
| 682 | |
| 683 | \wxheading{Parameters} |
| 684 | |
| 685 | \docparam{title}{The title to set.} |
| 686 | |
| 687 | \wxheading{Remarks} |
| 688 | |
| 689 | This is relevant only to popup menus, use |
| 690 | \helpref{wxMenuBar::SetLabelTop}{wxmenubarsetlabeltop} for the menus in the |
| 691 | menubar. |
| 692 | |
| 693 | \wxheading{See also} |
| 694 | |
| 695 | \helpref{wxMenu::GetTitle}{wxmenugettitle} |
| 696 | |
| 697 | |
| 698 | \membersection{wxMenu::UpdateUI}\label{wxmenuupdateui} |
| 699 | |
| 700 | \constfunc{void}{UpdateUI}{\param{wxEvtHandler*}{ source = NULL}} |
| 701 | |
| 702 | Sends events to {\it source} (or owning window if NULL) to update the |
| 703 | menu UI. This is called just before the menu is popped up with \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu}, but |
| 704 | the application may call it at other times if required. |
| 705 | |
| 706 | \wxheading{See also} |
| 707 | |
| 708 | \helpref{wxUpdateUIEvent}{wxupdateuievent} |
| 709 | |
| 710 | \section{\class{wxMenuBar}}\label{wxmenubar} |
| 711 | |
| 712 | A menu bar is a series of menus accessible from the top of a frame. |
| 713 | |
| 714 | \wxheading{Derived from} |
| 715 | |
| 716 | \helpref{wxWindow}{wxwindow}\\ |
| 717 | \helpref{wxEvtHandler}{wxevthandler}\\ |
| 718 | \helpref{wxObject}{wxobject} |
| 719 | |
| 720 | \wxheading{Include files} |
| 721 | |
| 722 | <wx/menu.h> |
| 723 | |
| 724 | \wxheading{Event handling} |
| 725 | |
| 726 | To respond to a menu selection, provide a handler for EVT\_MENU, in the frame |
| 727 | that contains the menu bar. If you have a toolbar which uses the same identifiers |
| 728 | as your EVT\_MENU entries, events from the toolbar will also be processed by your |
| 729 | EVT\_MENU event handlers. |
| 730 | |
| 731 | {\bf Tip:} under Windows, if you discover that menu shortcuts (for example, Alt-F to show the file menu) |
| 732 | are not working, check any EVT\_CHAR events you are handling in child windows. |
| 733 | If you are not calling {\tt event.Skip()} for events that you don't process in these event handlers, |
| 734 | menu shortcuts may cease to work. |
| 735 | |
| 736 | \wxheading{See also} |
| 737 | |
| 738 | \helpref{wxMenu}{wxmenu}, \helpref{Event handling overview}{eventhandlingoverview} |
| 739 | |
| 740 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 741 | |
| 742 | |
| 743 | \membersection{wxMenuBar::wxMenuBar}\label{wxmenubarctor} |
| 744 | |
| 745 | \func{}{wxMenuBar}{\param{long }{style = 0}} |
| 746 | |
| 747 | Default constructor. |
| 748 | |
| 749 | \func{}{wxMenuBar}{\param{size\_t}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}, \param{long }{style = 0}} |
| 750 | |
| 751 | Construct a menu bar from arrays of menus and titles. |
| 752 | |
| 753 | \wxheading{Parameters} |
| 754 | |
| 755 | \docparam{n}{The number of menus.} |
| 756 | |
| 757 | \docparam{menus}{An array of menus. Do not use this array again - it now belongs to the |
| 758 | menu bar.} |
| 759 | |
| 760 | \docparam{titles}{An array of title strings. Deallocate this array after creating the menu bar.} |
| 761 | |
| 762 | \docparam{style}{If {\tt wxMB\_DOCKABLE} the menu bar can be detached (wxGTK only).} |
| 763 | |
| 764 | \pythonnote{Only the default constructor is supported in wxPython. |
| 765 | Use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.} |
| 766 | |
| 767 | \perlnote{wxPerl only supports the first constructor: |
| 768 | use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.} |
| 769 | |
| 770 | |
| 771 | \membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor} |
| 772 | |
| 773 | \func{void}{\destruct{wxMenuBar}}{\void} |
| 774 | |
| 775 | Destructor, destroying the menu bar and removing it from the parent frame (if any). |
| 776 | |
| 777 | |
| 778 | \membersection{wxMenuBar::Append}\label{wxmenubarappend} |
| 779 | |
| 780 | \func{bool}{Append}{\param{wxMenu *}{menu}, \param{const wxString\& }{title}} |
| 781 | |
| 782 | Adds the item to the end of the menu bar. |
| 783 | |
| 784 | \wxheading{Parameters} |
| 785 | |
| 786 | \docparam{menu}{The menu to add. Do not deallocate this menu after calling {\bf Append}.} |
| 787 | |
| 788 | \docparam{title}{The title of the menu.} |
| 789 | |
| 790 | \wxheading{Return value} |
| 791 | |
| 792 | true on success, false if an error occurred. |
| 793 | |
| 794 | \wxheading{See also} |
| 795 | |
| 796 | \helpref{wxMenuBar::Insert}{wxmenubarinsert} |
| 797 | |
| 798 | |
| 799 | \membersection{wxMenuBar::Check}\label{wxmenubarcheck} |
| 800 | |
| 801 | \func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}} |
| 802 | |
| 803 | Checks or unchecks a menu item. |
| 804 | |
| 805 | \wxheading{Parameters} |
| 806 | |
| 807 | \docparam{id}{The menu item identifier.} |
| 808 | |
| 809 | \docparam{check}{If true, checks the menu item, otherwise the item is unchecked.} |
| 810 | |
| 811 | \wxheading{Remarks} |
| 812 | |
| 813 | Only use this when the menu bar has been associated |
| 814 | with a frame; otherwise, use the wxMenu equivalent call. |
| 815 | |
| 816 | |
| 817 | \membersection{wxMenuBar::Enable}\label{wxmenubarenable} |
| 818 | |
| 819 | \func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}} |
| 820 | |
| 821 | Enables or disables (greys out) a menu item. |
| 822 | |
| 823 | \wxheading{Parameters} |
| 824 | |
| 825 | \docparam{id}{The menu item identifier.} |
| 826 | |
| 827 | \docparam{enable}{true to enable the item, false to disable it.} |
| 828 | |
| 829 | \wxheading{Remarks} |
| 830 | |
| 831 | Only use this when the menu bar has been |
| 832 | associated with a frame; otherwise, use the wxMenu equivalent call. |
| 833 | |
| 834 | |
| 835 | \membersection{wxMenuBar::EnableTop}\label{wxmenubarenabletop} |
| 836 | |
| 837 | \func{void}{EnableTop}{\param{int}{ pos}, \param{const bool}{ enable}} |
| 838 | |
| 839 | Enables or disables a whole menu. |
| 840 | |
| 841 | \wxheading{Parameters} |
| 842 | |
| 843 | \docparam{pos}{The position of the menu, starting from zero.} |
| 844 | |
| 845 | \docparam{enable}{true to enable the menu, false to disable it.} |
| 846 | |
| 847 | \wxheading{Remarks} |
| 848 | |
| 849 | Only use this when the menu bar has been |
| 850 | associated with a frame. |
| 851 | |
| 852 | |
| 853 | \membersection{wxMenuBar::FindMenu}\label{wxmenubarfindmenu} |
| 854 | |
| 855 | \constfunc{int}{FindMenu}{\param{const wxString\& }{title}} |
| 856 | |
| 857 | Returns the index of the menu with the given {\it title} or {\tt wxNOT\_FOUND} if no |
| 858 | such menu exists in this menubar. The {\it title} parameter may specify either |
| 859 | the menu title (with accelerator characters, i.e. {\tt "\&File"}) or just the |
| 860 | menu label ({\tt "File"}) indifferently. |
| 861 | |
| 862 | |
| 863 | \membersection{wxMenuBar::FindMenuItem}\label{wxmenubarfindmenuitem} |
| 864 | |
| 865 | \constfunc{int}{FindMenuItem}{\param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}} |
| 866 | |
| 867 | Finds the menu item id for a menu name/menu item string pair. |
| 868 | |
| 869 | \wxheading{Parameters} |
| 870 | |
| 871 | \docparam{menuString}{Menu title to find.} |
| 872 | |
| 873 | \docparam{itemString}{Item to find.} |
| 874 | |
| 875 | \wxheading{Return value} |
| 876 | |
| 877 | The menu item identifier, or {\tt wxNOT\_FOUND} if none was found. |
| 878 | |
| 879 | \wxheading{Remarks} |
| 880 | |
| 881 | Any special menu codes are stripped out of source and target strings |
| 882 | before matching. |
| 883 | |
| 884 | |
| 885 | \membersection{wxMenuBar::FindItem}\label{wxmenubarfinditem} |
| 886 | |
| 887 | \constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu}{ **menu = NULL}} |
| 888 | |
| 889 | Finds the menu item object associated with the given menu item identifier. |
| 890 | |
| 891 | \wxheading{Parameters} |
| 892 | |
| 893 | \docparam{id}{Menu item identifier.} |
| 894 | |
| 895 | \docparam{menu}{If not NULL, menu will get set to the associated menu.} |
| 896 | |
| 897 | \wxheading{Return value} |
| 898 | |
| 899 | The found menu item object, or NULL if one was not found. |
| 900 | |
| 901 | |
| 902 | \membersection{wxMenuBar::GetHelpString}\label{wxmenubargethelpstring} |
| 903 | |
| 904 | \constfunc{wxString}{GetHelpString}{\param{int}{ id}} |
| 905 | |
| 906 | Gets the help string associated with the menu item identifier. |
| 907 | |
| 908 | \wxheading{Parameters} |
| 909 | |
| 910 | \docparam{id}{The menu item identifier.} |
| 911 | |
| 912 | \wxheading{Return value} |
| 913 | |
| 914 | The help string, or the empty string if there was no help string or the menu item |
| 915 | was not found. |
| 916 | |
| 917 | \wxheading{See also} |
| 918 | |
| 919 | \helpref{wxMenuBar::SetHelpString}{wxmenubarsethelpstring} |
| 920 | |
| 921 | |
| 922 | \membersection{wxMenuBar::GetLabel}\label{wxmenubargetlabel} |
| 923 | |
| 924 | \constfunc{wxString}{GetLabel}{\param{int}{ id}} |
| 925 | |
| 926 | Gets the label associated with a menu item. |
| 927 | |
| 928 | \wxheading{Parameters} |
| 929 | |
| 930 | \docparam{id}{The menu item identifier.} |
| 931 | |
| 932 | \wxheading{Return value} |
| 933 | |
| 934 | The menu item label, or the empty string if the item was not found. |
| 935 | |
| 936 | \wxheading{Remarks} |
| 937 | |
| 938 | Use only after the menubar has been associated with a frame. |
| 939 | |
| 940 | |
| 941 | \membersection{wxMenuBar::GetLabelTop}\label{wxmenubargetlabeltop} |
| 942 | |
| 943 | \constfunc{wxString}{GetLabelTop}{\param{int}{ pos}} |
| 944 | |
| 945 | Returns the label of a top-level menu. Note that the returned string does not |
| 946 | include the accelerator characters which could have been specified in the menu |
| 947 | title string during its construction. |
| 948 | |
| 949 | \wxheading{Parameters} |
| 950 | |
| 951 | \docparam{pos}{Position of the menu on the menu bar, starting from zero.} |
| 952 | |
| 953 | \wxheading{Return value} |
| 954 | |
| 955 | The menu label, or the empty string if the menu was not found. |
| 956 | |
| 957 | \wxheading{Remarks} |
| 958 | |
| 959 | Use only after the menubar has been associated with a frame. |
| 960 | |
| 961 | \wxheading{See also} |
| 962 | |
| 963 | \helpref{wxMenuBar::SetLabelTop}{wxmenubarsetlabeltop} |
| 964 | |
| 965 | |
| 966 | \membersection{wxMenuBar::GetMenu}\label{wxmenubargetmenu} |
| 967 | |
| 968 | \constfunc{wxMenu*}{GetMenu}{\param{int}{ menuIndex}} |
| 969 | |
| 970 | Returns the menu at {\it menuIndex} (zero-based). |
| 971 | |
| 972 | |
| 973 | \membersection{wxMenuBar::GetMenuCount}\label{wxmenubargetmenucount} |
| 974 | |
| 975 | \constfunc{int}{GetMenuCount}{\void} |
| 976 | |
| 977 | Returns the number of menus in this menubar. |
| 978 | |
| 979 | |
| 980 | \membersection{wxMenuBar::Insert}\label{wxmenubarinsert} |
| 981 | |
| 982 | \func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}} |
| 983 | |
| 984 | Inserts the menu at the given position into the menu bar. Inserting menu at |
| 985 | position $0$ will insert it in the very beginning of it, inserting at position |
| 986 | \helpref{GetMenuCount()}{wxmenubargetmenucount} is the same as calling |
| 987 | \helpref{Append()}{wxmenubarappend}. |
| 988 | |
| 989 | \wxheading{Parameters} |
| 990 | |
| 991 | \docparam{pos}{The position of the new menu in the menu bar} |
| 992 | |
| 993 | \docparam{menu}{The menu to add. wxMenuBar owns the menu and will free it.} |
| 994 | |
| 995 | \docparam{title}{The title of the menu.} |
| 996 | |
| 997 | \wxheading{Return value} |
| 998 | |
| 999 | true on success, false if an error occurred. |
| 1000 | |
| 1001 | \wxheading{See also} |
| 1002 | |
| 1003 | \helpref{wxMenuBar::Append}{wxmenubarappend} |
| 1004 | |
| 1005 | |
| 1006 | \membersection{wxMenuBar::IsChecked}\label{wxmenubarischecked} |
| 1007 | |
| 1008 | \constfunc{bool}{IsChecked}{\param{int}{ id}} |
| 1009 | |
| 1010 | Determines whether an item is checked. |
| 1011 | |
| 1012 | \wxheading{Parameters} |
| 1013 | |
| 1014 | \docparam{id}{The menu item identifier.} |
| 1015 | |
| 1016 | \wxheading{Return value} |
| 1017 | |
| 1018 | true if the item was found and is checked, false otherwise. |
| 1019 | |
| 1020 | |
| 1021 | \membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled} |
| 1022 | |
| 1023 | \constfunc{bool}{IsEnabled}{\param{int}{ id}} |
| 1024 | |
| 1025 | Determines whether an item is enabled. |
| 1026 | |
| 1027 | \wxheading{Parameters} |
| 1028 | |
| 1029 | \docparam{id}{The menu item identifier.} |
| 1030 | |
| 1031 | \wxheading{Return value} |
| 1032 | |
| 1033 | true if the item was found and is enabled, false otherwise. |
| 1034 | |
| 1035 | |
| 1036 | \membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh} |
| 1037 | |
| 1038 | \func{void}{Refresh}{\void} |
| 1039 | |
| 1040 | Redraw the menu bar |
| 1041 | |
| 1042 | |
| 1043 | \membersection{wxMenuBar::Remove}\label{wxmenubarremove} |
| 1044 | |
| 1045 | \func{wxMenu *}{Remove}{\param{size\_t }{pos}} |
| 1046 | |
| 1047 | Removes the menu from the menu bar and returns the menu object - the caller is |
| 1048 | responsible for deleting it. This function may be used together with |
| 1049 | \helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar |
| 1050 | dynamically. |
| 1051 | |
| 1052 | \wxheading{See also} |
| 1053 | |
| 1054 | \helpref{wxMenuBar::Replace}{wxmenubarreplace} |
| 1055 | |
| 1056 | |
| 1057 | \membersection{wxMenuBar::Replace}\label{wxmenubarreplace} |
| 1058 | |
| 1059 | \func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}} |
| 1060 | |
| 1061 | Replaces the menu at the given position with another one. |
| 1062 | |
| 1063 | \wxheading{Parameters} |
| 1064 | |
| 1065 | \docparam{pos}{The position of the new menu in the menu bar} |
| 1066 | |
| 1067 | \docparam{menu}{The menu to add.} |
| 1068 | |
| 1069 | \docparam{title}{The title of the menu.} |
| 1070 | |
| 1071 | \wxheading{Return value} |
| 1072 | |
| 1073 | The menu which was previously at position {\it pos}. The caller is |
| 1074 | responsible for deleting it. |
| 1075 | |
| 1076 | \wxheading{See also} |
| 1077 | |
| 1078 | \helpref{wxMenuBar::Insert}{wxmenubarinsert},\rtfsp |
| 1079 | \helpref{wxMenuBar::Remove}{wxmenubarremove} |
| 1080 | |
| 1081 | |
| 1082 | \membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring} |
| 1083 | |
| 1084 | \func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}} |
| 1085 | |
| 1086 | Sets the help string associated with a menu item. |
| 1087 | |
| 1088 | \wxheading{Parameters} |
| 1089 | |
| 1090 | \docparam{id}{Menu item identifier.} |
| 1091 | |
| 1092 | \docparam{helpString}{Help string to associate with the menu item.} |
| 1093 | |
| 1094 | \wxheading{See also} |
| 1095 | |
| 1096 | \helpref{wxMenuBar::GetHelpString}{wxmenubargethelpstring} |
| 1097 | |
| 1098 | |
| 1099 | \membersection{wxMenuBar::SetLabel}\label{wxmenubarsetlabel} |
| 1100 | |
| 1101 | \func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}} |
| 1102 | |
| 1103 | Sets the label of a menu item. |
| 1104 | |
| 1105 | \wxheading{Parameters} |
| 1106 | |
| 1107 | \docparam{id}{Menu item identifier.} |
| 1108 | |
| 1109 | \docparam{label}{Menu item label.} |
| 1110 | |
| 1111 | \wxheading{Remarks} |
| 1112 | |
| 1113 | Use only after the menubar has been associated with a frame. |
| 1114 | |
| 1115 | \wxheading{See also} |
| 1116 | |
| 1117 | \helpref{wxMenuBar::GetLabel}{wxmenubargetlabel} |
| 1118 | |
| 1119 | |
| 1120 | \membersection{wxMenuBar::SetLabelTop}\label{wxmenubarsetlabeltop} |
| 1121 | |
| 1122 | \func{void}{SetLabelTop}{\param{int}{ pos}, \param{const wxString\& }{label}} |
| 1123 | |
| 1124 | Sets the label of a top-level menu. |
| 1125 | |
| 1126 | \wxheading{Parameters} |
| 1127 | |
| 1128 | \docparam{pos}{The position of a menu on the menu bar, starting from zero.} |
| 1129 | |
| 1130 | \docparam{label}{The menu label.} |
| 1131 | |
| 1132 | \wxheading{Remarks} |
| 1133 | |
| 1134 | Use only after the menubar has been associated with a frame. |
| 1135 | |
| 1136 | \wxheading{See also} |
| 1137 | |
| 1138 | \helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop} |
| 1139 | |