added generic implementation and documentation for wxFindReplaceDialog

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

diff --git a/include/wx/gtk/menu.h b/include/wx/gtk/menu.h
index 5ce6c353ccfb0ed90a347f89ab180e7d2aaea5ed..f36c816d2a5e724cfc0ff82fb0761dd6142c67c3 100644 (file)
--- a/include/wx/gtk/menu.h
+++ b/include/wx/gtk/menu.h
@@ -1,171 +1,113 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        menu.h
+// Name:        wx/gtk/menu.h

 // Purpose:
 // Author:      Robert Roebling
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef __GTKMENUH__
 #define __GTKMENUH__
 
 #ifdef __GNUG__
 #ifndef __GTKMENUH__
 #define __GTKMENUH__
 
 #ifdef __GNUG__

-#pragma interface
+    #pragma interface "menu.h"

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/window.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxMenuBar;
-class wxMenuItem;
-class wxMenu;
-
-//-----------------------------------------------------------------------------
-// const
-//-----------------------------------------------------------------------------
-
-#define   ID_SEPARATOR    (-1)
-

 //-----------------------------------------------------------------------------
 // wxMenuBar
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxMenuBar
 //-----------------------------------------------------------------------------
 

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

 {
 {

-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;
-  
-  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[]);
+    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 SetLabelTop( size_t pos, const wxString& label );
+    virtual wxString GetLabelTop( size_t pos ) const;
+
+    // implementation only from now on
+    void SetInvokingWindow( wxWindow *win );
+    void UnsetInvokingWindow( wxWindow *win );
+
+    // common part of Append and Insert
+    bool GtkAppend(wxMenu *menu, const wxString& title);
+
+    GtkAccelGroup   *m_accel;
+    GtkItemFactory  *m_factory;
+    GtkWidget       *m_menubar;
+    long             m_style;
+    wxWindow        *m_invokingWindow;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)

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

-class wxMenuItem: public wxObject
+class wxMenu : public wxMenuBase

 {
 {

-DECLARE_DYNAMIC_CLASS(wxMenuItem)
-

 public:
 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) { m_isEnabled = enable; }
-  bool IsEnabled() const { return m_isEnabled; }
-  void Check(bool check = TRUE);
-  bool IsChecked() const;
-
-    // help string (displayed in the status bar by default)
-  void SetHelpString(const wxString& str) { m_helpStr = str; }
-
-  // implementation
-  void SetMenuItem(GtkWidget *menuItem) { m_menuItem = menuItem; }
-  GtkWidget *GetMenuItem() const { return m_menuItem; }
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }

 
 

-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
-};
+    wxMenu(long style = 0) : wxMenuBase(style) { Init(); }

 
 

-class wxMenu: public wxEvtHandler
-{
-DECLARE_DYNAMIC_CLASS(wxMenu)
+    virtual ~wxMenu();

 
 

-public:
-  // construction
-  wxMenu( const wxString& title = wxEmptyString, const wxFunction func = NULL );
-
-  // operations
-    // 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() {};
-
-    // find item by name/id
-  int FindItem( const wxString itemString ) const;
-  wxMenuItem *FindItem(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 );
-
-  // 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();
+    // implement base class virtuals
+    virtual bool DoAppend(wxMenuItem *item);
+    virtual bool DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem *DoRemove(wxMenuItem *item);
+
+    // TODO: virtual void SetTitle(const wxString& title);
+
+    // compatibility only
+#if wxUSE_MENU_CALLBACK
+    wxMenu(const wxString& title, const wxFunction func)
+        : wxMenuBase(title)
+    {
+        Init();
+
+        Callback(func);
+    }
+#endif // WXWIN_COMPATIBILITY_2
+
+    // implementation
+    int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
+
+    // implementation GTK only
+    GtkWidget       *m_menu;  // GtkMenu
+    GtkWidget       *m_owner;
+    GtkAccelGroup   *m_accel;
+    GtkItemFactory  *m_factory;
+
+private:
+    // common code for all constructors:
+    void Init();

 
 

-  wxString       m_title;
-  wxList         m_items;
-  wxWindow      *m_invokingWindow;
-  wxFunction     m_callback;
-  wxEvtHandler  *m_eventHandler;
+    // common part of Append and Insert
+    bool GtkAppend(wxMenuItem *item);

 
 

-  GtkWidget     *m_menu;  // GtkMenu
+    DECLARE_DYNAMIC_CLASS(wxMenu)

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