]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/motif/menu.h
wxMemoryStream doc updated
[wxWidgets.git] / include / wx / motif / menu.h
index f89f733d11f5ec8bdcd188a84c8b615e5991b398..d3d47056548b2d1b1ae56ba544fa9d0328717ad6 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     17/09/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_
@@ -18,6 +18,8 @@
 
 #include "wx/defs.h"
 #include "wx/event.h"
+#include "wx/font.h"
+#include "wx/gdicmn.h"
 
 class WXDLLEXPORT wxMenuItem;
 class WXDLLEXPORT wxMenuBar;
@@ -34,8 +36,17 @@ class WXDLLEXPORT wxMenu: public wxEvtHandler
 
 public:
   // ctor & dtor
-  wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL);
-  ~wxMenu();
+#ifdef WXWIN_COMPATIBILITY
+    wxMenu( const wxString& title, const wxFunction func)
+    {
+        Init(title, 0, func);
+    }
+#endif // WXWIN_COMPATIBILITY
+    wxMenu( const wxString& title = wxEmptyString, long style = 0 )
+    {
+        Init(title, style);
+    }
+  virtual ~wxMenu();
 
   // construct menu
     // append items to the menu
@@ -45,7 +56,7 @@ public:
   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, 
+  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);
@@ -57,10 +68,14 @@ public:
   // menu item control
   void Enable(int id, bool Flag);
   bool Enabled(int id) const;
-  inline bool IsEnabled(int id) const { return Enabled(id); };
+  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); };
+  bool IsChecked(int id) const { return IsChecked(id); };
+
+  // Client data
+  void SetClientData(void* clientData) { m_clientData = clientData; }
+  void* GetClientData() const { return m_clientData; }
 
   // item properties
     // title
@@ -79,24 +94,36 @@ public:
     // 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; }
+
+#ifdef WXWIN_COMPATIBILITY
+  void Callback(const wxFunction func) { m_callback = func; }
+#endif // WXWIN_COMPATIBILITY
 
   virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
-  inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-  inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+  void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
+  wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 
-  inline wxList& GetItems() const { return (wxList&) m_menuItems; }
+  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; }
+  WXWidget GetButtonWidget() const { return m_buttonWidget; }
+  void SetButtonWidget(WXWidget buttonWidget) { m_buttonWidget = buttonWidget; }
+  WXWidget GetMainWidget() const { return m_menuWidget; }
+  wxMenu* GetParent() const { return m_menuParent; }
+  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);
@@ -111,8 +138,23 @@ public:
   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);
+
+  // implementation from now on
+  WXWidget GetHandle() const { return m_menuWidget; }
+  bool IsTearOff() const { return (m_style & wxMENU_TEAROFF) != 0; }
+
 public:
+#ifdef WXWIN_COMPATIBILITY
   wxFunction        m_callback;
+#endif // WXWIN_COMPATIBILITY
 
   int               m_noItems;
   wxString          m_title;
@@ -120,6 +162,10 @@ public:
   wxList            m_menuItems;
   wxEvtHandler *    m_parent;
   wxEvtHandler *    m_eventHandler;
+  void*             m_clientData;
+  wxWindow*         m_pInvokingWindow;
+
+  long              m_style;
 
   //// Motif-specific
   int               m_numColumns;
@@ -130,69 +176,102 @@ public:
   wxMenu*           m_topLevelMenu ;
   wxMenu*           m_menuParent;
   bool              m_ownedByMenuBar;
+  wxColour          m_foregroundColour;
+  wxColour          m_backgroundColour;
+  wxFont            m_font;
+
+private:
+    // common code for both constructors:
+    void Init( const wxString& title,
+               long style
+#ifdef WXWIN_COMPATIBILITY
+               , const wxFunction func = (wxFunction) NULL
+#endif
+               );
 };
 
 // ----------------------------------------------------------------------------
 // Menu Bar (a la Windows)
 // ----------------------------------------------------------------------------
+
 class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar: public wxEvtHandler
+class WXDLLEXPORT wxMenuBar : public wxEvtHandler
 {
-  DECLARE_DYNAMIC_CLASS(wxMenuBar)
-
-  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);
+DECLARE_DYNAMIC_CLASS(wxMenuBar)
 
-  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; }
-
- public:
-  wxEvtHandler *            m_eventHandler;
-  int                       m_menuCount;
-  wxMenu **                 m_menus;
-  wxString *                m_titles;
-  wxFrame *                 m_menuBarFrame;
-
-  //// Motif-specific
-  WXWidget                  m_mainWidget;
+public:
+    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 ;
+    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 ;
+    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 ;
+
+    void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
+    wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+
+    int GetMenuCount() const { return m_menuCount; }
+    wxMenu* GetMenu(int i) const { return m_menus[i]; }
+
+    //// Motif-specific
+    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; }
+
+    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;
 };
 
 #endif // _WX_MENU_H_