1. some minor but nasty bugs fixed (see post to the list)

[wxWidgets.git] / include / wx / gtk / menu.h

diff --git a/include/wx/gtk/menu.h b/include/wx/gtk/menu.h
index 78445e7432759a3703896aed44d37bc604db73aa..f571fe084edf377de5056b88c869942b1a4d5a85 100644 (file)
--- a/include/wx/gtk/menu.h
+++ b/include/wx/gtk/menu.h
@@ -39,107 +39,154 @@ class wxMenu;
 // wxMenuBar
 //-----------------------------------------------------------------------------
 
 // wxMenuBar
 //-----------------------------------------------------------------------------
 

-class wxMenuBar: public wxWindow
+class wxMenuBar : public wxWindow

 {
 {

-DECLARE_DYNAMIC_CLASS(wxMenuBar)
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)

 
 public:
 
 public:

-  wxMenuBar();
-  void Append( wxMenu *menu, const wxString &title );
-
-  int FindMenuItem( const wxString &menuString, const wxString &itemString ) const;
-  wxMenuItem* FindMenuItemById( int id ) const;
-  inline wxMenuItem* FindItemForId( int id ) const
-    { return FindMenuItemById( id ); }
-  
-  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); };
-  
-  wxString GetLabel( int id ) const;
-  void SetLabel( int id, const wxString &label );
-  
-  void EnableTop( int pos, bool flag );
-  void SetLabelTop( int pos, const wxString& label );
-  wxString GetLabelTop( int pos ) const;
-
-  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; }
+
+    GtkAccelGroup   *m_accel;
+    GtkItemFactory  *m_factory;
+    wxList           m_menus;
+    GtkWidget       *m_menubar;

 };
 
 //-----------------------------------------------------------------------------
 // wxMenu
 //-----------------------------------------------------------------------------
 
 };
 
 //-----------------------------------------------------------------------------
 // wxMenu
 //-----------------------------------------------------------------------------
 

-class wxMenu: public wxEvtHandler
+class wxMenu : public wxEvtHandler

 {
 {

-DECLARE_DYNAMIC_CLASS(wxMenu)
+    DECLARE_DYNAMIC_CLASS(wxMenu)

 
 public:
 
 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() {};
+    wxMenu( const wxString& title = wxEmptyString,
+            const wxFunction func = (wxFunction) NULL );
+    ~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() { }

 
     // find item by name/id
 
     // find item by name/id

-  int FindItem( const wxString itemString ) const;
-  wxMenuItem *FindItem( int id ) const;
-  wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
+    int FindItem( const wxString itemString ) const;
+    wxMenuItem *FindItem( int id ) const;

 
     // get/set item's state
 
     // 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; }
-  
-  inline void SetClientData( void* clientData ) { m_clientData = clientData; }
-  inline void* GetClientData() const { return m_clientData; }
-  
-// implementation
-  
-  int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
-  void SetInvokingWindow( wxWindow *win );
-  wxWindow *GetInvokingWindow();
-
-  wxString       m_title;
-  wxList         m_items;
-  wxWindow      *m_invokingWindow;
-  wxFunction     m_callback;
-  wxEvtHandler  *m_eventHandler;
-  void          *m_clientData;
-
-  GtkWidget     *m_menu;  // GtkMenu
+    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; }
+
+    void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
+    wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+
+    void SetClientData( void* clientData ) { m_clientData = clientData; }
+    void* GetClientData() const { return m_clientData; }
+
+    // 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 ); }
+
+#ifdef WXWIN_COMPATIBILITY
+    wxFunction GetCallback() const { return m_callback; }
+    void Callback(const wxFunction func) { m_callback = func; }
+
+    // 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;
+
+private:
+
+    wxString       m_title;
+    wxList         m_items;
+    wxWindow      *m_invokingWindow;
+    wxFunction     m_callback;
+    wxEvtHandler  *m_eventHandler;
+    void          *m_clientData;

 };
 
 #endif // __GTKMENUH__
 };
 
 #endif // __GTKMENUH__