]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/motif/menu.h
Implement support for wxRIBBON_PANEL_EXT_BUTTON wxRibbonPanel style.
[wxWidgets.git] / include / wx / motif / menu.h
index 22ddece86e9cb293a41b024148e77774a841149d..a48c219af04a68b37b6e250f6ae108bde42ba8d3 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        menu.h
+// Name:        wx/motif/menu.h
 // Purpose:     wxMenu, wxMenuBar classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     17/09/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_MENU_H_
-#define _WX_MENU_H_
+#ifndef _WX_MOTIF_MENU_H_
+#define _WX_MOTIF_MENU_H_
 
-#ifdef __GNUG__
-#pragma interface "menu.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/event.h"
+#include "wx/colour.h"
 #include "wx/font.h"
-#include "wx/gdicmn.h"
-
-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenu;
+#include "wx/arrstr.h"
 
-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+class WXDLLIMPEXP_FWD_CORE wxFrame;
 
 // ----------------------------------------------------------------------------
 // Menu
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxMenu: public wxEvtHandler
-{
-  DECLARE_DYNAMIC_CLASS(wxMenu)
 
+class WXDLLIMPEXP_CORE wxMenu : public wxMenuBase
+{
 public:
-  // ctor & dtor
-  wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL);
-  ~wxMenu();
-
-  // construct menu
-    // append items to the menu
-      // separator line
-  void AppendSeparator();
-      // normal item
-  void Append(int id, const wxString& Label, const wxString& helpString = wxEmptyString,
-              bool checkable = FALSE);
-      // a submenu
-  void Append(int id, const wxString& Label, wxMenu *SubMenu, 
-              const wxString& helpString = wxEmptyString);
-      // the most generic form (create wxMenuItem first and use it's functions)
-  void Append(wxMenuItem *pItem);
-    // insert a break in the menu
-  void Break();
-    // delete an item
-  void Delete(int id);
-
-  // menu item control
-  void Enable(int id, bool Flag);
-  bool Enabled(int id) const;
-  inline bool IsEnabled(int id) const { return Enabled(id); };
-  void Check(int id, bool Flag);
-  bool Checked(int id) const;
-  inline bool IsChecked(int id) const { return IsChecked(id); };
-
-  // Client data
-  inline void SetClientData(void* clientData) { m_clientData = clientData; }
-  inline void* GetClientData() const { return m_clientData; }
-
-  // item properties
-    // title
-  void SetTitle(const wxString& label);
-  const wxString GetTitle() const;
-    // label
-  void SetLabel(int id, const wxString& label);
-  wxString GetLabel(int id) const;
-    // help string
-  virtual void SetHelpString(int id, const wxString& helpString);
-  virtual wxString GetHelpString(int id) const ;
-
-  // find item
-    // Finds the item id matching the given string, -1 if not found.
-  virtual int FindItem(const wxString& itemString) const ;
-    // Find wxMenuItem by ID, and item's menu too if itemMenu is !NULL.
-  wxMenuItem *FindItemForId(int itemId, wxMenu **itemMenu = NULL) const;
-
-  // 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);
-
-  void ProcessCommand(wxCommandEvent& event);
-  inline void Callback(const wxFunction func) { m_callback = func; }
-
-  virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
-  inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-  inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-  inline wxList& GetItems() const { return (wxList&) m_menuItems; }
-
-  void      SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
-  wxWindow *GetInvokingWindow()         const { return m_pInvokingWindow; }
-
-  //// Motif-specific
-  inline WXWidget GetButtonWidget() const { return m_buttonWidget; }
-  inline void SetButtonWidget(WXWidget buttonWidget) { m_buttonWidget = buttonWidget; }
-  inline WXWidget GetMainWidget() const { return m_menuWidget; }
-  inline wxMenu* GetParent() const { return m_menuParent; }
-  inline int GetId() const { return m_menuId; }
-  inline void SetId(int id) { m_menuId = id; }
-  inline void SetMenuBar(wxMenuBar* menuBar) { m_menuBar = menuBar; }
-  inline wxMenuBar* GetMenuBar() const { return m_menuBar; }
-
-  void CreatePopup (WXWidget logicalParent, int x, int y);
-  void DestroyPopup (void);
-  void ShowPopup (int x, int y);
-  void HidePopup (void);
-
-  WXWidget CreateMenu(wxMenuBar *menuBar, WXWidget parent, wxMenu *topMenu,
-            const wxString& title = "", bool isPulldown = FALSE);
-
-  // For popups, need to destroy, then recreate menu for a different (or
-  // possibly same) window, since the parent may change.
-  void DestroyMenu(bool full);
-  WXWidget FindMenuItem(int id, wxMenuItem **it = NULL) const;
-
-  const wxColour& GetBackgroundColour() const { return m_backgroundColour; }
-  const wxColour& GetForegroundColour() const { return m_foregroundColour; }
-  const wxFont& GetFont() const { return m_font; }
-
-  void SetBackgroundColour(const wxColour& colour);
-  void SetForegroundColour(const wxColour& colour);
-  void SetFont(const wxFont& colour);
-  void ChangeFont(bool keepOriginalSize = FALSE);
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }
+
+    wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
+
+    virtual ~wxMenu();
+
+    // implement base class virtuals
+    virtual wxMenuItem* DoAppend(wxMenuItem *item);
+    virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem* DoRemove(wxMenuItem *item);
+
+    virtual void Break();
+
+    virtual void SetTitle(const wxString& title);
+
+    bool ProcessCommand(wxCommandEvent& event);
+
+    //// Motif-specific
+    WXWidget GetButtonWidget() const { return m_buttonWidget; }
+    void SetButtonWidget(WXWidget buttonWidget) { m_buttonWidget = buttonWidget; }
+
+    WXWidget GetMainWidget() const { return m_menuWidget; }
+
+    int GetId() const { return m_menuId; }
+    void SetId(int id) { m_menuId = id; }
+
+    void SetMenuBar(wxMenuBar* menuBar) { m_menuBar = menuBar; }
+    wxMenuBar* GetMenuBar() const { return m_menuBar; }
+
+    void CreatePopup(WXWidget logicalParent, int x, int y);
+    void DestroyPopup();
+    void ShowPopup(int x, int y);
+    void HidePopup();
+
+    WXWidget CreateMenu(wxMenuBar *menuBar, WXWidget parent, wxMenu *topMenu,
+        size_t index, const wxString& title = wxEmptyString,
+        bool isPulldown = false);
+
+    // For popups, need to destroy, then recreate menu for a different (or
+    // possibly same) window, since the parent may change.
+    void DestroyMenu(bool full);
+    WXWidget FindMenuItem(int id, wxMenuItem **it = NULL) const;
+
+    const wxColour& GetBackgroundColour() const { return m_backgroundColour; }
+    const wxColour& GetForegroundColour() const { return m_foregroundColour; }
+    const wxFont& GetFont() const { return m_font; }
+
+    void SetBackgroundColour(const wxColour& colour);
+    void SetForegroundColour(const wxColour& colour);
+    void SetFont(const wxFont& colour);
+    void ChangeFont(bool keepOriginalSize = false);
+
+    WXWidget GetHandle() const { return m_menuWidget; }
 
+    bool IsTearOff() const { return (m_style & wxMENU_TEAROFF) != 0; }
+
+    void DestroyWidgetAndDetach();
 public:
-  wxFunction        m_callback;
-
-  int               m_noItems;
-  wxString          m_title;
-  wxMenuBar *       m_menuBar;
-  wxList            m_menuItems;
-  wxEvtHandler *    m_parent;
-  wxEvtHandler *    m_eventHandler;
-  void*             m_clientData;
-  wxWindow*         m_pInvokingWindow;
-
-  //// Motif-specific
-  int               m_numColumns;
-  WXWidget          m_menuWidget;
-  WXWidget          m_popupShell;   // For holding the popup shell widget
-  WXWidget          m_buttonWidget; // The actual string, so we can grey it etc.
-  int               m_menuId;
-  wxMenu*           m_topLevelMenu ;
-  wxMenu*           m_menuParent;
-  bool              m_ownedByMenuBar;
-  wxColour          m_foregroundColour;
-  wxColour          m_backgroundColour;
-  wxFont            m_font;
+    // Motif-specific data
+    int               m_numColumns;
+    WXWidget          m_menuWidget;
+    WXWidget          m_popupShell;   // For holding the popup shell widget
+    WXWidget          m_buttonWidget; // The actual string, so we can grey it etc.
+    int               m_menuId;
+    wxMenu*           m_topLevelMenu ;
+    bool              m_ownedByMenuBar;
+    wxColour          m_foregroundColour;
+    wxColour          m_backgroundColour;
+    wxFont            m_font;
+
+private:
+    // common code for both constructors:
+    void Init();
+
+    DECLARE_DYNAMIC_CLASS(wxMenu)
 };
 
 // ----------------------------------------------------------------------------
-// Menu Bar (a la Windows)
+// Menu Bar
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar: public wxEvtHandler
+
+class WXDLLIMPEXP_CORE wxMenuBar : public wxMenuBarBase
 {
-  DECLARE_DYNAMIC_CLASS(wxMenuBar)
-
-  wxMenuBar( long style );
-  wxMenuBar();
-  wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
-  ~wxMenuBar();
-
-  void Append(wxMenu *menu, const wxString& title);
-  // Must only be used AFTER menu has been attached to frame,
-  // otherwise use individual menus to enable/disable items
-  void Enable(int Id, bool Flag);
-  bool Enabled(int Id) const ;
-  inline bool IsEnabled(int Id) const { return Enabled(Id); };
-  void EnableTop(int pos, bool Flag);
-  void Check(int id, bool Flag);
-  bool Checked(int id) const ;
-  inline bool IsChecked(int Id) const { return Checked(Id); };
-  void SetLabel(int id, const wxString& label) ;
-  wxString GetLabel(int id) const ;
-  void SetLabelTop(int pos, const wxString& label) ;
-  wxString GetLabelTop(int pos) const ;
-  virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
-  virtual bool OnAppend(wxMenu *menu, const char *title);
-  virtual bool OnDelete(wxMenu *menu, int index);
-
-  virtual void SetHelpString(int Id, const wxString& helpString);
-  virtual wxString GetHelpString(int Id) const ;
-
-  virtual int FindMenuItem(const wxString& menuString, const wxString& itemString) const ;
-
-  // Find wxMenuItem for item ID, and return item's
-  // menu too if itemMenu is non-NULL.
-  wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const ;
-
-  inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-  inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-  inline int GetMenuCount() const { return m_menuCount; }
-  inline wxMenu* GetMenu(int i) const { return m_menus[i]; }
-
-  //// Motif-specific
-  inline wxFrame* GetMenuBarFrame() const { return m_menuBarFrame; }
-  inline void SetMenuBarFrame(wxFrame* frame) { m_menuBarFrame = frame; }
-  inline WXWidget GetMainWidget() const { return m_mainWidget; }
-  inline void SetMainWidget(WXWidget widget) { m_mainWidget = widget; }
-
-  // Create menubar
-  bool CreateMenuBar(wxFrame* frame);
-
-  // Destroy menubar, but keep data structures intact so we can recreate it.
-  bool DestroyMenuBar();
-
-  const wxColour& GetBackgroundColour() const { return m_backgroundColour; }
-  const wxColour& GetForegroundColour() const { return m_foregroundColour; }
-  const wxFont& GetFont() const { return m_font; }
-
-  void SetBackgroundColour(const wxColour& colour);
-  void SetForegroundColour(const wxColour& colour);
-  void SetFont(const wxFont& colour);
-  void ChangeFont(bool keepOriginalSize = FALSE);
-
- public:
-  wxEvtHandler *            m_eventHandler;
-  int                       m_menuCount;
-  wxMenu **                 m_menus;
-  wxString *                m_titles;
-  wxFrame *                 m_menuBarFrame;
-
-  //// Motif-specific
-  WXWidget                  m_mainWidget;
-
-  wxColour                  m_foregroundColour;
-  wxColour                  m_backgroundColour;
-  wxFont                    m_font;
+public:
+    wxMenuBar() { Init(); }
+    wxMenuBar(long WXUNUSED(style)) { Init(); }
+    wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);
+    wxMenuBar(size_t n, wxMenu *menus[], const wxArrayString& titles, long style = 0);
+    virtual ~wxMenuBar();
+
+    // implement base class (pure) virtuals
+    // ------------------------------------
+
+    virtual bool Append( wxMenu *menu, const wxString &title );
+    virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
+    virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
+    virtual wxMenu *Remove(size_t pos);
+
+    virtual int FindMenuItem(const wxString& menuString,
+        const wxString& itemString) const;
+    virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;
+
+    virtual void EnableTop( size_t pos, bool flag );
+    virtual void SetMenuLabel( size_t pos, const wxString& label );
+    virtual wxString GetMenuLabel( size_t pos ) const;
+
+    // implementation only from now on
+    // -------------------------------
+
+    wxFrame* GetMenuBarFrame() const { return m_menuBarFrame; }
+    void SetMenuBarFrame(wxFrame* frame) { m_menuBarFrame = frame; }
+    WXWidget GetMainWidget() const { return m_mainWidget; }
+    void SetMainWidget(WXWidget widget) { m_mainWidget = widget; }
+
+    // Create menubar
+    bool CreateMenuBar(wxFrame* frame);
+
+    // Destroy menubar, but keep data structures intact so we can recreate it.
+    bool DestroyMenuBar();
+
+    const wxColour& GetBackgroundColour() const { return m_backgroundColour; }
+    const wxColour& GetForegroundColour() const { return m_foregroundColour; }
+    const wxFont& GetFont() const { return m_font; }
+
+    virtual bool SetBackgroundColour(const wxColour& colour);
+    virtual bool SetForegroundColour(const wxColour& colour);
+    virtual bool SetFont(const wxFont& colour);
+    void ChangeFont(bool keepOriginalSize = false);
+
+public:
+    // common part of all ctors
+    void Init();
+
+    wxArrayString m_titles;
+    wxFrame      *m_menuBarFrame;
+
+    WXWidget      m_mainWidget;
+
+    wxColour      m_foregroundColour;
+    wxColour      m_backgroundColour;
+    wxFont        m_font;
+
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)
 };
 
-#endif // _WX_MENU_H_
+#endif // _WX_MOTIF_MENU_H_