// Modified by:
// Created: 26.10.99
// RCS-ID: $Id$
-// Copyright: (c) wxWindows team
+// Copyright: (c) wxWidgets team
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_MENU_H_BASE_
#define _WX_MENU_H_BASE_
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma interface "menubase.h"
-#endif
-
#include "wx/defs.h"
#if wxUSE_MENUS
// included wx/menu.h
#include "wx/menuitem.h"
-class WXDLLEXPORT wxMenu;
-class WXDLLEXPORT wxMenuBarBase;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenuItem;
+class WXDLLIMPEXP_FWD_CORE wxMenu;
+class WXDLLIMPEXP_FWD_CORE wxMenuBarBase;
+class WXDLLIMPEXP_FWD_CORE wxMenuBar;
+class WXDLLIMPEXP_FWD_CORE wxMenuItem;
// pseudo template list classes
WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
// -----------------
// append any kind of item (normal/check/radio/separator)
- void Append(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString,
- wxItemKind kind = wxITEM_NORMAL)
+ wxMenuItem* Append(int itemid,
+ const wxString& text = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL)
{
- DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
+ return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
}
// append a separator to the menu
- void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
+ wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); }
// append a check item
- void AppendCheckItem(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* AppendCheckItem(int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- Append(itemid, text, help, wxITEM_CHECK);
+ return Append(itemid, text, help, wxITEM_CHECK);
}
// append a radio item
- void AppendRadioItem(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* AppendRadioItem(int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- Append(itemid, text, help, wxITEM_RADIO);
+ return Append(itemid, text, help, wxITEM_RADIO);
}
// append a submenu
- void Append(int itemid,
- const wxString& text,
- wxMenu *submenu,
- const wxString& help = wxEmptyString)
+ wxMenuItem* AppendSubMenu(wxMenu *submenu,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
- wxITEM_NORMAL, submenu));
+ return DoAppend(wxMenuItem::New((wxMenu *)this, wxID_ANY, text, help,
+ wxITEM_NORMAL, submenu));
}
// the most generic form of Append() - append anything
- void Append(wxMenuItem *item) { DoAppend(item); }
+ wxMenuItem* Append(wxMenuItem *item) { return DoAppend(item); }
// insert a break in the menu (only works when appending the items, not
// inserting them)
virtual void Break() { }
// insert an item before given position
- bool Insert(size_t pos, wxMenuItem *item);
+ wxMenuItem* Insert(size_t pos, wxMenuItem *item);
// insert an item before given position
- void Insert(size_t pos,
- int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString,
- wxItemKind kind = wxITEM_NORMAL)
+ wxMenuItem* Insert(size_t pos,
+ int itemid,
+ const wxString& text = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL)
{
- Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
+ return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
}
// insert a separator
- void InsertSeparator(size_t pos)
+ wxMenuItem* InsertSeparator(size_t pos)
{
- Insert(pos, wxMenuItem::New((wxMenu *)this));
+ return Insert(pos, wxMenuItem::New((wxMenu *)this, wxID_SEPARATOR));
}
// insert a check item
- void InsertCheckItem(size_t pos,
- int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* InsertCheckItem(size_t pos,
+ int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- Insert(pos, itemid, text, help, wxITEM_CHECK);
+ return Insert(pos, itemid, text, help, wxITEM_CHECK);
}
// insert a radio item
- void InsertRadioItem(size_t pos,
- int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* InsertRadioItem(size_t pos,
+ int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- Insert(pos, itemid, text, help, wxITEM_RADIO);
+ return Insert(pos, itemid, text, help, wxITEM_RADIO);
}
// insert a submenu
- void Insert(size_t pos,
- int itemid,
- const wxString& text,
- wxMenu *submenu,
- const wxString& help = wxEmptyString)
+ wxMenuItem* Insert(size_t pos,
+ int itemid,
+ const wxString& text,
+ wxMenu *submenu,
+ const wxString& help = wxEmptyString)
{
- Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help,
- wxITEM_NORMAL, submenu));
+ return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help,
+ wxITEM_NORMAL, submenu));
}
// prepend an item to the menu
- void Prepend(wxMenuItem *item)
+ wxMenuItem* Prepend(wxMenuItem *item)
{
- Insert(0u, item);
+ return Insert(0u, item);
}
// prepend any item to the menu
- void Prepend(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString,
- wxItemKind kind = wxITEM_NORMAL)
+ wxMenuItem* Prepend(int itemid,
+ const wxString& text = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL)
{
- Insert(0u, itemid, text, help, kind);
+ return Insert(0u, itemid, text, help, kind);
}
// prepend a separator
- void PrependSeparator()
+ wxMenuItem* PrependSeparator()
{
- InsertSeparator(0u);
+ return InsertSeparator(0u);
}
// prepend a check item
- void PrependCheckItem(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* PrependCheckItem(int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- InsertCheckItem(0u, itemid, text, help);
+ return InsertCheckItem(0u, itemid, text, help);
}
// prepend a radio item
- void PrependRadioItem(int itemid,
- const wxString& text,
- const wxString& help = wxEmptyString)
+ wxMenuItem* PrependRadioItem(int itemid,
+ const wxString& text,
+ const wxString& help = wxEmptyString)
{
- InsertRadioItem(0u, itemid, text, help);
+ return InsertRadioItem(0u, itemid, text, help);
}
// prepend a submenu
- void Prepend(int itemid,
- const wxString& text,
- wxMenu *submenu,
- const wxString& help = wxEmptyString)
+ wxMenuItem* Prepend(int itemid,
+ const wxString& text,
+ wxMenu *submenu,
+ const wxString& help = wxEmptyString)
{
- Insert(0u, itemid, text, submenu, help);
+ return Insert(0u, itemid, text, submenu, help);
}
// detach an item from the menu, but don't delete it so that it can be
void SetLabel(int itemid, const wxString& label);
wxString GetLabel(int itemid) const;
+ // Returns the stripped label
+ wxString GetLabelText(int itemid) const { return wxMenuItem::GetLabelText(GetLabel(itemid)); }
+
virtual void SetHelpString(int itemid, const wxString& helpString);
virtual wxString GetHelpString(int itemid) const;
void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
// get the menu bar this menu is attached to (may be NULL, always NULL for
- // popup menus)
- wxMenuBar *GetMenuBar() const { return m_menuBar; }
+ // popup menus). Traverse up the menu hierarchy to find it.
+ wxMenuBar *GetMenuBar() const;
// called when the menu is attached/detached to/from a menu bar
virtual void Attach(wxMenuBarBase *menubar);
virtual void Detach();
// is the menu attached to a menu bar (or is it a popup one)?
- bool IsAttached() const { return m_menuBar != NULL; }
+ bool IsAttached() const { return GetMenuBar() != NULL; }
// set/get the parent of this menu
void SetParent(wxMenu *parent) { m_menuParent = parent; }
// pos != NULL
wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const;
- // called to generate a wxCommandEvent, return TRUE if it was processed,
- // FALSE otherwise
+ // called to generate a wxCommandEvent, return true if it was processed,
+ // false otherwise
//
// the checked parameter may have boolean value or -1 for uncheckable items
bool SendEvent(int itemid, int checked = -1);
Append(itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
}
+ // use more readable and not requiring unused itemid AppendSubMenu() instead
+ wxMenuItem* Append(int itemid,
+ const wxString& text,
+ wxMenu *submenu,
+ const wxString& help = wxEmptyString)
+ {
+ return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
+ wxITEM_NORMAL, submenu));
+ }
+
void Insert(size_t pos,
int itemid,
const wxString& text,
Insert(0u, itemid, text, help, isCheckable);
}
+ static void LockAccels(bool locked)
+ {
+ ms_locked = locked;
+ }
+
protected:
// virtuals to override in derived classes
// ---------------------------------------
- virtual bool DoAppend(wxMenuItem *item);
- virtual bool DoInsert(size_t pos, wxMenuItem *item);
+ virtual wxMenuItem* DoAppend(wxMenuItem *item);
+ virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
virtual wxMenuItem *DoRemove(wxMenuItem *item);
virtual bool DoDelete(wxMenuItem *item);
wxEvtHandler *m_eventHandler; // a pluggable in event handler
+ static bool ms_locked;
+
DECLARE_NO_COPY_CLASS(wxMenuBase)
};
// menu bar construction
// ---------------------
- // append a menu to the end of menubar, return TRUE if ok
+ // append a menu to the end of menubar, return true if ok
virtual bool Append(wxMenu *menu, const wxString& title);
- // insert a menu before the given position into the menubar, return TRUE
+ // insert a menu before the given position into the menubar, return true
// if inserted ok
virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
virtual void EnableTop(size_t pos, bool enable) = 0;
// is the menu enabled?
- virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return TRUE; }
+ virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return true; }
// get or change the label of the menu at given position
- virtual void SetLabelTop(size_t pos, const wxString& label) = 0;
- virtual wxString GetLabelTop(size_t pos) const = 0;
+ virtual void SetMenuLabel(size_t pos, const wxString& label) = 0;
+ virtual wxString GetMenuLabel(size_t pos) const = 0;
+
+ // get the stripped label of the menu at given position
+ virtual wxString GetMenuLabelText(size_t pos) const { return wxMenuItem::GetLabelText(GetMenuLabel(pos)); }
// item search
// -----------
void Check(int itemid, bool check);
bool IsChecked(int itemid) const;
bool IsEnabled(int itemid) const;
+ virtual bool IsEnabled() const { return wxWindow::IsEnabled(); }
void SetLabel(int itemid, const wxString &label);
wxString GetLabel(int itemid) const;
// get the frame we are attached to (may return NULL)
wxFrame *GetFrame() const { return m_menuBarFrame; }
- // returns TRUE if we're attached to a frame
+ // returns true if we're attached to a frame
bool IsAttached() const { return GetFrame() != NULL; }
// associate the menubar with the frame
virtual void Detach();
// need to override these ones to avoid virtual function hiding
- virtual bool Enable(bool enable = TRUE) { return wxWindow::Enable(enable); }
+ virtual bool Enable(bool enable = true) { return wxWindow::Enable(enable); }
virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); }
virtual wxString GetLabel() const { return wxWindow::GetLabel(); }
// don't want menu bars to accept the focus by tabbing to them
- virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
+ virtual bool AcceptsFocusFromKeyboard() const { return false; }
+
+ // update all menu item states in all menus
+ virtual void UpdateMenus();
+
+ virtual bool CanBeOutsideClientArea() const { return true; }
+
+#if WXWIN_COMPATIBILITY_2_8
+ // get or change the label of the menu at given position
+ wxDEPRECATED( void SetLabelTop(size_t pos, const wxString& label) );
+ wxDEPRECATED( wxString GetLabelTop(size_t pos) const );
+#endif
protected:
// the list of all our menus
#else // !wxUSE_BASE_CLASSES_ONLY
#if defined(__WXUNIVERSAL__)
#include "wx/univ/menu.h"
+#elif defined(__WXPALMOS__)
+ #include "wx/palmos/menu.h"
#elif defined(__WXMSW__)
#include "wx/msw/menu.h"
#elif defined(__WXMOTIF__)
#include "wx/motif/menu.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
#include "wx/gtk/menu.h"
+#elif defined(__WXGTK__)
+ #include "wx/gtk1/menu.h"
#elif defined(__WXMAC__)
#include "wx/mac/menu.h"
#elif defined(__WXCOCOA__)
projects / wxWidgets.git / blobdiff