// Name: menu.h
// Purpose:
// Author: Robert Roebling
-// Created: 01/02/97
-// Id:
-// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Id: $Id$
+// Copyright: (c) 1998 Robert Roebling, Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/object.h"
#include "wx/list.h"
#include "wx/window.h"
+#include "wx/menuitem.h"
//-----------------------------------------------------------------------------
// classes
// wxMenuBar
//-----------------------------------------------------------------------------
-class wxMenuBar: public wxWindow
+class wxMenuBar : public wxWindow
{
-DECLARE_DYNAMIC_CLASS(wxMenuBar)
+ DECLARE_DYNAMIC_CLASS(wxMenuBar)
public:
- wxMenuBar();
- void Append( wxMenu *menu, const wxString &title );
-
- int FindMenuItem( const wxString &menuString, const wxString &itemString ) const;
- wxMenuItem* FindMenuItemById( int id ) const;
-
- void Check( int id, bool check );
- bool Checked( int id ) const;
- void Enable( int id, bool enable );
- bool Enabled( int id ) const;
- inline bool IsEnabled(int Id) const { return Enabled(Id); };
- inline bool IsChecked(int Id) const { return Checked(Id); };
-
- int GetMenuCount() const { return m_menus.Number(); }
- wxMenu *GetMenu(int n) const { return (wxMenu *)m_menus.Nth(n)->Data(); }
-
- wxList m_menus;
- GtkWidget *m_menubar;
+ // ctors
+ wxMenuBar();
+ wxMenuBar(long style);
+ wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
+ ~wxMenuBar();
+
+ // menubar construction
+ void Append( wxMenu *menu, const wxString &title );
+
+ // item search
+ // by menu and item names, returns wxNOT_FOUND if not found
+ virtual int FindMenuItem(const wxString& menuString,
+ const wxString& itemString) const;
+ // returns NULL if not found
+ wxMenuItem* FindItem( int id ) const;
+ // returns NULL if not found, fills menuForItem if !NULL
+ wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const;
+
+ // state control
+ void Check( int id, bool check );
+ bool IsChecked( int id ) const;
+ void Enable( int id, bool enable );
+ bool IsEnabled( int id ) const;
+
+ void SetLabel( int id, const wxString &label );
+ wxString GetLabel( int id ) const;
+ wxString GetLabel() const { return wxWindow::GetLabel(); }
+
+ void EnableTop( int pos, bool flag );
+ void SetLabelTop( int pos, const wxString& label );
+ wxString GetLabelTop( int pos ) const;
+
+ virtual void SetHelpString( int id, const wxString& helpString );
+ virtual wxString GetHelpString( int id ) const;
+
+ int GetMenuCount() const { return m_menus.Number(); }
+ wxMenu *GetMenu( int n ) const { return (wxMenu *)m_menus.Nth(n)->Data(); }
+
+#ifdef WXWIN_COMPATIBILITY
+ // compatibility: these functions are deprecated
+ bool Enabled(int id) const { return IsEnabled(id); }
+ bool Checked(int id) const { return IsChecked(id); }
+
+ wxMenuItem* FindMenuItemById( int id ) const { return FindItem(id); }
+#endif // WXWIN_COMPATIBILITY
+
+ // implementation only
+ wxList& GetMenus() { return m_menus; }
+
+ void SetInvokingWindow( wxWindow *win );
+ void UnsetInvokingWindow( wxWindow *win );
+
+ GtkAccelGroup *m_accel;
+ GtkItemFactory *m_factory;
+ wxList m_menus;
+ GtkWidget *m_menubar;
+ long m_style;
+ wxWindow *m_invokingWindow;
};
//-----------------------------------------------------------------------------
// wxMenu
//-----------------------------------------------------------------------------
-class wxMenuItem: public wxObject
+class wxMenu : public wxEvtHandler
{
-DECLARE_DYNAMIC_CLASS(wxMenuItem)
+ DECLARE_DYNAMIC_CLASS(wxMenu)
public:
- wxMenuItem();
-
- // accessors
- // id
- void SetId(int id) { m_id = id; }
- int GetId() const { return m_id; }
- bool IsSeparator() const { return m_id == ID_SEPARATOR; }
-
- // the item's text
- void SetText(const wxString& str);
- const wxString& GetText() const { return m_text; }
-
- // what kind of menu item we are
- void SetCheckable(bool checkable) { m_isCheckMenu = checkable; }
- bool IsCheckable() const { return m_isCheckMenu; }
- void SetSubMenu(wxMenu *menu) { m_subMenu = menu; }
- wxMenu *GetSubMenu() const { return m_subMenu; }
- bool IsSubMenu() const { return m_subMenu != NULL; }
-
- // state
- void Enable( bool enable = TRUE );
- bool IsEnabled() const { return m_isEnabled; }
- void Check( bool check = TRUE );
- bool IsChecked() const;
-
- // help string (displayed in the status bar by default)
- void SetHelp(const wxString& str) { m_helpStr = str; }
- const wxString& GetHelp() const { return m_helpStr; }
-
- // implementation
- void SetMenuItem(GtkWidget *menuItem) { m_menuItem = menuItem; }
- GtkWidget *GetMenuItem() const { return m_menuItem; }
+ wxMenu( const wxString& title, const wxFunction func)
+ {
+ Init(title, 0, func);
+ }
+ wxMenu( long style )
+ {
+ Init( wxEmptyString, style );
+ }
+ wxMenu( const wxString& title = wxEmptyString, long style = 0 )
+ {
+ Init(title, style);
+ }
+
+ ~wxMenu();
+
+ // operations
+ // title
+ void SetTitle(const wxString& label);
+ const wxString GetTitle() const;
+ // menu creation
+ void AppendSeparator();
+ void Append(int id, const wxString &item,
+ const wxString &helpStr = "", bool checkable = FALSE);
+ void Append(int id, const wxString &item,
+ wxMenu *subMenu, const wxString &helpStr = "" );
+ void Append(wxMenuItem *pItem);
+ void Break() { }
-private:
- int m_id;
- wxString m_text;
- bool m_isCheckMenu;
- bool m_isChecked;
- bool m_isEnabled;
- wxMenu *m_subMenu;
- wxString m_helpStr;
-
- GtkWidget *m_menuItem; // GtkMenuItem
-};
+ // find item by name/id
+ int FindItem( const wxString itemString ) const;
+ wxMenuItem *FindItem( int id ) const;
-class wxMenu: public wxEvtHandler
-{
-DECLARE_DYNAMIC_CLASS(wxMenu)
+ // get/set item's state
+ void Enable( int id, bool enable );
+ bool IsEnabled( int id ) const;
+ void Check( int id, bool check );
+ bool IsChecked( int id ) const;
-public:
- // construction
- wxMenu( const wxString& title = wxEmptyString, const wxFunction func = (wxFunction) NULL );
-
- // operations
- // title
- void SetTitle(const wxString& label);
- const wxString GetTitle() const;
- // menu creation
- void AppendSeparator();
- void Append(int id, const wxString &item,
- const wxString &helpStr = "", bool checkable = FALSE);
- void Append(int id, const wxString &item,
- wxMenu *subMenu, const wxString &helpStr = "" );
- void Break() {};
+ void SetLabel( int id, const wxString &label );
+ wxString GetLabel( int id ) const;
- // find item by name/id
- int FindItem( const wxString itemString ) const;
- wxMenuItem *FindItem( int id ) const;
- wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
+ // helpstring
+ virtual void SetHelpString(int id, const wxString& helpString);
+ virtual wxString GetHelpString(int id) const ;
- // get/set item's state
- 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;
-
- // helpstring
- virtual void SetHelpString(int id, const wxString& helpString);
- virtual wxString GetHelpString(int id) const ;
-
- // accessors
- wxList& GetItems() { return m_items; }
-
- inline void Callback(const wxFunction func) { m_callback = func; }
-
- inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
- inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-public:
- int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
- void SetInvokingWindow( wxWindow *win );
- wxWindow *GetInvokingWindow();
+ // accessors
+ wxList& GetItems() { return m_items; }
+
+ void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
+ wxEvtHandler *GetEventHandler() { return m_eventHandler; }
- wxString m_title;
- wxList m_items;
- wxWindow *m_invokingWindow;
- wxFunction m_callback;
- wxEvtHandler *m_eventHandler;
+ void SetClientData( void* clientData ) { m_clientData = clientData; }
+ void* GetClientData() const { return m_clientData; }
- GtkWidget *m_menu; // GtkMenu
+ // 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);
+
+ wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
+
+ wxFunction GetCallback() const { return m_callback; }
+ void Callback(const wxFunction func) { m_callback = func; }
+ wxFunction m_callback;
+
+#ifdef WXWIN_COMPATIBILITY
+
+ // compatibility: these functions are deprecated
+ bool Enabled(int id) const { return IsEnabled(id); }
+ bool Checked(int id) const { return IsChecked(id); }
+
+#endif // WXWIN_COMPATIBILITY
+
+ // implementation
+ int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
+ void SetInvokingWindow( wxWindow *win );
+ wxWindow *GetInvokingWindow();
+
+ // implementation GTK only
+ GtkWidget *m_menu; // GtkMenu
+ GtkWidget *m_owner;
+ GtkAccelGroup *m_accel;
+ GtkItemFactory *m_factory;
+
+ // used by wxMenuBar
+ long GetStyle(void) const { return m_style; }
+
+private:
+ // common code for both constructors:
+ void Init( const wxString& title,
+ long style,
+ const wxFunction func = (wxFunction) NULL );
+
+ wxString m_title;
+ wxList m_items;
+ wxWindow *m_invokingWindow;
+ wxEvtHandler *m_eventHandler;
+ void *m_clientData;
+ long m_style;
};
#endif // __GTKMENUH__
projects / wxWidgets.git / blobdiff