e9e4acc519
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18573 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
551 lines
17 KiB
C++
551 lines
17 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/menu.h
|
|
// Purpose: wxMenu and wxMenuBar classes
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 26.10.99
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) wxWindows team
|
|
// Licence: wxWindows license
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_MENU_H_BASE_
|
|
#define _WX_MENU_H_BASE_
|
|
|
|
#if defined(__GNUG__) && !defined(__APPLE__)
|
|
#pragma interface "menubase.h"
|
|
#endif
|
|
|
|
#if wxUSE_MENUS
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/list.h" // for "template" list classes
|
|
#include "wx/window.h" // base class for wxMenuBar
|
|
|
|
// also include this one to ensure compatibility with old code which only
|
|
// included wx/menu.h
|
|
#include "wx/menuitem.h"
|
|
|
|
class WXDLLEXPORT wxMenu;
|
|
class WXDLLEXPORT wxMenuBarBase;
|
|
class WXDLLEXPORT wxMenuBar;
|
|
class WXDLLEXPORT wxMenuItem;
|
|
|
|
// pseudo template list classes
|
|
WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
|
|
WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList);
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// conditional compilation
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// having callbacks in menus is a wxWin 1.6x feature which should be replaced
|
|
// with event tables in wxWin 2.xx code - however provide it because many
|
|
// people like it a lot by default
|
|
#ifndef wxUSE_MENU_CALLBACK
|
|
#if WXWIN_COMPATIBILITY_2
|
|
#define wxUSE_MENU_CALLBACK 1
|
|
#else
|
|
#define wxUSE_MENU_CALLBACK 0
|
|
#endif // WXWIN_COMPATIBILITY_2
|
|
#endif // !defined(wxUSE_MENU_CALLBACK)
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxMenu
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxMenuBase : public wxEvtHandler
|
|
{
|
|
public:
|
|
// create a menu
|
|
static wxMenu *New(const wxString& title = wxEmptyString, long style = 0);
|
|
|
|
// ctors
|
|
wxMenuBase(const wxString& title, long style = 0) : m_title(title)
|
|
{ Init(style); }
|
|
wxMenuBase(long style = 0)
|
|
{ Init(style); }
|
|
|
|
// dtor deletes all the menu items we own
|
|
virtual ~wxMenuBase();
|
|
|
|
// menu construction
|
|
// -----------------
|
|
|
|
// append any kind of item (normal/check/radio/separator)
|
|
void Append(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString,
|
|
wxItemKind kind = wxITEM_NORMAL)
|
|
{
|
|
DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, kind));
|
|
}
|
|
|
|
// append a separator to the menu
|
|
void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
|
|
|
|
// append a check item
|
|
void AppendCheckItem(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Append(id, text, help, wxITEM_CHECK);
|
|
}
|
|
|
|
// append a radio item
|
|
void AppendRadioItem(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Append(id, text, help, wxITEM_RADIO);
|
|
}
|
|
|
|
// append a submenu
|
|
void Append(int id,
|
|
const wxString& text,
|
|
wxMenu *submenu,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help,
|
|
wxITEM_NORMAL, submenu));
|
|
}
|
|
|
|
// the most generic form of Append() - append anything
|
|
void Append(wxMenuItem *item) { 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);
|
|
|
|
// insert an item before given position
|
|
void Insert(size_t pos,
|
|
int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString,
|
|
wxItemKind kind = wxITEM_NORMAL)
|
|
{
|
|
Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, kind));
|
|
}
|
|
|
|
// insert a separator
|
|
void InsertSeparator(size_t pos)
|
|
{
|
|
Insert(pos, wxMenuItem::New((wxMenu *)this));
|
|
}
|
|
|
|
// insert a check item
|
|
void InsertCheckItem(size_t pos,
|
|
int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Insert(pos, id, text, help, wxITEM_CHECK);
|
|
}
|
|
|
|
// insert a radio item
|
|
void InsertRadioItem(size_t pos,
|
|
int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Insert(pos, id, text, help, wxITEM_RADIO);
|
|
}
|
|
|
|
// insert a submenu
|
|
void Insert(size_t pos,
|
|
int id,
|
|
const wxString& text,
|
|
wxMenu *submenu,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help,
|
|
wxITEM_NORMAL, submenu));
|
|
}
|
|
|
|
// prepend an item to the menu
|
|
void Prepend(wxMenuItem *item)
|
|
{
|
|
Insert(0u, item);
|
|
}
|
|
|
|
// prepend any item to the menu
|
|
void Prepend(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString,
|
|
wxItemKind kind = wxITEM_NORMAL)
|
|
{
|
|
Insert(0u, id, text, help, kind);
|
|
}
|
|
|
|
// prepend a separator
|
|
void PrependSeparator()
|
|
{
|
|
InsertSeparator(0u);
|
|
}
|
|
|
|
// prepend a check item
|
|
void PrependCheckItem(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
InsertCheckItem(0u, id, text, help);
|
|
}
|
|
|
|
// prepend a radio item
|
|
void PrependRadioItem(int id,
|
|
const wxString& text,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
InsertRadioItem(0u, id, text, help);
|
|
}
|
|
|
|
// prepend a submenu
|
|
void Prepend(int id,
|
|
const wxString& text,
|
|
wxMenu *submenu,
|
|
const wxString& help = wxEmptyString)
|
|
{
|
|
Insert(0u, id, text, submenu, help);
|
|
}
|
|
|
|
// detach an item from the menu, but don't delete it so that it can be
|
|
// added back later (but if it's not, the caller is responsible for
|
|
// deleting it!)
|
|
wxMenuItem *Remove(int id) { return Remove(FindChildItem(id)); }
|
|
wxMenuItem *Remove(wxMenuItem *item);
|
|
|
|
// delete an item from the menu (submenus are not destroyed by this
|
|
// function, see Destroy)
|
|
bool Delete(int id) { return Delete(FindChildItem(id)); }
|
|
bool Delete(wxMenuItem *item);
|
|
|
|
// delete the item from menu and destroy it (if it's a submenu)
|
|
bool Destroy(int id) { return Destroy(FindChildItem(id)); }
|
|
bool Destroy(wxMenuItem *item);
|
|
|
|
// menu items access
|
|
// -----------------
|
|
|
|
// get the items
|
|
size_t GetMenuItemCount() const { return m_items.GetCount(); }
|
|
|
|
const wxMenuItemList& GetMenuItems() const { return m_items; }
|
|
wxMenuItemList& GetMenuItems() { return m_items; }
|
|
|
|
// search
|
|
virtual int FindItem(const wxString& item) const;
|
|
wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
|
|
|
|
// get/set items attributes
|
|
void Enable(int id, bool enable);
|
|
bool IsEnabled(int id) const;
|
|
|
|
void Check(int id, bool check);
|
|
bool IsChecked(int id) const;
|
|
|
|
void SetLabel(int id, const wxString& label);
|
|
wxString GetLabel(int id) const;
|
|
|
|
virtual void SetHelpString(int id, const wxString& helpString);
|
|
virtual wxString GetHelpString(int id) const;
|
|
|
|
// misc accessors
|
|
// --------------
|
|
|
|
// the title
|
|
virtual void SetTitle(const wxString& title) { m_title = title; }
|
|
const wxString GetTitle() const { return m_title; }
|
|
|
|
// event handler
|
|
void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
|
|
wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
|
|
|
|
// invoking window
|
|
void SetInvokingWindow(wxWindow *win) { m_invokingWindow = win; }
|
|
wxWindow *GetInvokingWindow() const { return m_invokingWindow; }
|
|
|
|
// style
|
|
long GetStyle() const { return m_style; }
|
|
|
|
// implementation helpers
|
|
// ----------------------
|
|
|
|
// Updates the UI for a menu and all submenus recursively. source is the
|
|
// object that has the update event handlers defined for it. If NULL, the
|
|
// menu or associated window will be used.
|
|
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; }
|
|
|
|
// 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; }
|
|
|
|
// set/get the parent of this menu
|
|
void SetParent(wxMenu *parent) { m_menuParent = parent; }
|
|
wxMenu *GetParent() const { return m_menuParent; }
|
|
|
|
// implementation only from now on
|
|
// -------------------------------
|
|
|
|
// unlike FindItem(), this function doesn't recurse but only looks through
|
|
// our direct children and also may return the index of the found child if
|
|
// pos != NULL
|
|
wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
|
|
|
|
// 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 id, int checked = -1);
|
|
|
|
// compatibility: these functions are deprecated, use the new ones instead
|
|
// -----------------------------------------------------------------------
|
|
|
|
// use the versions taking wxItem_XXX now instead, they're more readable
|
|
// and allow adding the radio items as well
|
|
void Append(int id,
|
|
const wxString& text,
|
|
const wxString& help,
|
|
bool isCheckable)
|
|
{
|
|
Append(id, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
|
|
}
|
|
|
|
void Insert(size_t pos,
|
|
int id,
|
|
const wxString& text,
|
|
const wxString& help,
|
|
bool isCheckable)
|
|
{
|
|
Insert(pos, id, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
|
|
}
|
|
|
|
void Prepend(int id,
|
|
const wxString& text,
|
|
const wxString& help,
|
|
bool isCheckable)
|
|
{
|
|
Insert(0u, id, text, help, isCheckable);
|
|
}
|
|
|
|
#if WXWIN_COMPATIBILITY
|
|
bool Enabled(int id) const { return IsEnabled(id); }
|
|
bool Checked(int id) const { return IsChecked(id); }
|
|
|
|
wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const
|
|
{ return FindItem(itemId, itemMenu); }
|
|
|
|
wxList& GetItems() const { return (wxList &)m_items; }
|
|
#endif // WXWIN_COMPATIBILITY
|
|
|
|
#if wxUSE_MENU_CALLBACK || defined(__WXMOTIF__)
|
|
// wxWin 1.6x compatible menu event handling
|
|
wxFunction GetCallback() const { return m_callback; }
|
|
void Callback(const wxFunction func) { m_callback = func; }
|
|
|
|
wxFunction m_callback;
|
|
#endif // wxUSE_MENU_CALLBACK
|
|
|
|
protected:
|
|
// virtuals to override in derived classes
|
|
// ---------------------------------------
|
|
|
|
virtual bool DoAppend(wxMenuItem *item);
|
|
virtual bool DoInsert(size_t pos, wxMenuItem *item);
|
|
|
|
virtual wxMenuItem *DoRemove(wxMenuItem *item);
|
|
virtual bool DoDelete(wxMenuItem *item);
|
|
virtual bool DoDestroy(wxMenuItem *item);
|
|
|
|
// helpers
|
|
// -------
|
|
|
|
// common part of all ctors
|
|
void Init(long style);
|
|
|
|
// associate the submenu with this menu
|
|
void AddSubMenu(wxMenu *submenu);
|
|
|
|
wxMenuBar *m_menuBar; // menubar we belong to or NULL
|
|
wxMenu *m_menuParent; // parent menu or NULL
|
|
|
|
wxString m_title; // the menu title or label
|
|
wxMenuItemList m_items; // the list of menu items
|
|
|
|
wxWindow *m_invokingWindow; // for popup menus
|
|
|
|
long m_style; // combination of wxMENU_XXX flags
|
|
|
|
wxEvtHandler *m_eventHandler; // a pluggable in event handler
|
|
|
|
DECLARE_NO_COPY_CLASS(wxMenuBase)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxMenuBar
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxMenuBarBase : public wxWindow
|
|
{
|
|
public:
|
|
// default ctor
|
|
wxMenuBarBase();
|
|
|
|
// dtor will delete all menus we own
|
|
virtual ~wxMenuBarBase();
|
|
|
|
// menu bar construction
|
|
// ---------------------
|
|
|
|
// 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
|
|
// if inserted ok
|
|
virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
|
|
|
|
// menu bar items access
|
|
// ---------------------
|
|
|
|
// get the number of menus in the menu bar
|
|
size_t GetMenuCount() const { return m_menus.GetCount(); }
|
|
|
|
// get the menu at given position
|
|
wxMenu *GetMenu(size_t pos) const;
|
|
|
|
// replace the menu at given position with another one, returns the
|
|
// previous menu (which should be deleted by the caller)
|
|
virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
|
|
|
|
// delete the menu at given position from the menu bar, return the pointer
|
|
// to the menu (which should be deleted by the caller)
|
|
virtual wxMenu *Remove(size_t pos);
|
|
|
|
// enable or disable a submenu
|
|
virtual void EnableTop(size_t pos, bool enable) = 0;
|
|
|
|
// is the menu enabled?
|
|
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;
|
|
|
|
// item search
|
|
// -----------
|
|
|
|
// by menu and item names, returns wxNOT_FOUND if not found or id of the
|
|
// found item
|
|
virtual int FindMenuItem(const wxString& menu, const wxString& item) const;
|
|
|
|
// find item by id (in any menu), returns NULL if not found
|
|
//
|
|
// if menu is !NULL, it will be filled with wxMenu this item belongs to
|
|
virtual wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const;
|
|
|
|
// find menu by its caption, return wxNOT_FOUND on failure
|
|
int FindMenu(const wxString& title) const;
|
|
|
|
// item access
|
|
// -----------
|
|
|
|
// all these functions just use FindItem() and then call an appropriate
|
|
// method on it
|
|
//
|
|
// NB: under MSW, these methods can only be used after the menubar had
|
|
// been attached to the frame
|
|
|
|
void Enable(int id, bool enable);
|
|
void Check(int id, bool check);
|
|
bool IsChecked(int id) const;
|
|
bool IsEnabled(int id) const;
|
|
|
|
void SetLabel(int id, const wxString &label);
|
|
wxString GetLabel(int id) const;
|
|
|
|
void SetHelpString(int id, const wxString& helpString);
|
|
wxString GetHelpString(int id) const;
|
|
|
|
// implementation helpers
|
|
|
|
// 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
|
|
bool IsAttached() const { return GetFrame() != NULL; }
|
|
|
|
// associate the menubar with the frame
|
|
virtual void Attach(wxFrame *frame);
|
|
|
|
// called before deleting the menubar normally
|
|
virtual void Detach();
|
|
|
|
// need to override these ones to avoid virtual function hiding
|
|
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; }
|
|
|
|
// compatibility only: these functions are deprecated, use the new ones
|
|
// instead
|
|
#if WXWIN_COMPATIBILITY
|
|
bool Enabled(int id) const { return IsEnabled(id); }
|
|
bool Checked(int id) const { return IsChecked(id); }
|
|
|
|
wxMenuItem* FindMenuItemById(int id) const
|
|
{ return FindItem(id); }
|
|
wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const
|
|
{ return FindItem(id, menu); }
|
|
#endif // WXWIN_COMPATIBILITY
|
|
|
|
protected:
|
|
// the list of all our menus
|
|
wxMenuList m_menus;
|
|
|
|
// the frame we are attached to (may be NULL)
|
|
wxFrame *m_menuBarFrame;
|
|
|
|
DECLARE_NO_COPY_CLASS(wxMenuBarBase)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// include the real class declaration
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#ifdef wxUSE_BASE_CLASSES_ONLY
|
|
#define wxMenuItem wxMenuItemBase
|
|
#else // !wxUSE_BASE_CLASSES_ONLY
|
|
#if defined(__WXUNIVERSAL__)
|
|
#include "wx/univ/menu.h"
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/menu.h"
|
|
#elif defined(__WXMOTIF__)
|
|
#include "wx/motif/menu.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk/menu.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/mac/menu.h"
|
|
#elif defined(__WXPM__)
|
|
#include "wx/os2/menu.h"
|
|
#endif
|
|
#endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
|
|
|
|
#endif // wxUSE_MENUS
|
|
|
|
#endif
|
|
// _WX_MENU_H_BASE_
|