give a name to the unnamed enum to make it easier to document it

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

diff --git a/include/wx/gtk/menu.h b/include/wx/gtk/menu.h
index 78445e7432759a3703896aed44d37bc604db73aa..b73dfc1c13f4a059e9592dfcf2303bdce6f96bde 100644 (file)
--- a/include/wx/gtk/menu.h
+++ b/include/wx/gtk/menu.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,139 +7,108 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTKMENU_H_
+#define _WX_GTKMENU_H_

 
 

-#ifndef __GTKMENUH__
-#define __GTKMENUH__
+//-----------------------------------------------------------------------------
+// wxMenuBar
+//-----------------------------------------------------------------------------

 
 

-#ifdef __GNUG__
-#pragma interface
-#endif
+class WXDLLIMPEXP_CORE wxMenuBar : public wxMenuBarBase
+{
+public:
+    // ctors
+    wxMenuBar();
+    wxMenuBar(long style);
+    wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);
+    virtual ~wxMenuBar();

 
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/window.h"
-#include "wx/menuitem.h"
+    // 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);

 
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+    virtual int FindMenuItem(const wxString& menuString,
+                             const wxString& itemString) const;
+    virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;

 
 

-class wxMenuBar;
-class wxMenuItem;
-class wxMenu;
+    virtual void EnableTop( size_t pos, bool flag );
+    virtual void SetMenuLabel( size_t pos, const wxString& label );
+    virtual wxString GetMenuLabel( size_t pos ) const;

 
 

-//-----------------------------------------------------------------------------
-// const
-//-----------------------------------------------------------------------------
+    void SetLayoutDirection(wxLayoutDirection dir);
+    wxLayoutDirection GetLayoutDirection() const;

 
 

-#define   ID_SEPARATOR    (-1)
+    // wxMenuBar is not a top level window but it still doesn't need a parent
+    // window
+    virtual bool GTKNeedsParent() const { return false; }

 
 

-//-----------------------------------------------------------------------------
-// wxMenuBar
-//-----------------------------------------------------------------------------
+    void Attach(wxFrame *frame);

 
 

-class wxMenuBar: public wxWindow
-{
-DECLARE_DYNAMIC_CLASS(wxMenuBar)
+    // implementation only from now on
+    void SetInvokingWindow( wxWindow *win );
+    void UnsetInvokingWindow( wxWindow *win );

 
 

-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;
+private:
+    // common part of Append and Insert
+    bool GtkAppend(wxMenu *menu, const wxString& title, int pos=-1);
+
+    GtkWidget       *m_menubar;
+    wxWindow        *m_invokingWindow;
+
+    void Init(size_t n, wxMenu *menus[], const wxString titles[], long style);
+
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)

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

-class wxMenu: public wxEvtHandler
+class WXDLLIMPEXP_CORE wxMenu : public wxMenuBase

 {
 {

-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() {};
-
-    // find item by name/id
-  int FindItem( const wxString itemString ) const;
-  wxMenuItem *FindItem( int id ) const;
-  wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
-
-    // 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
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }
+
+    wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
+
+    virtual ~wxMenu();
+
+    void Attach(wxMenuBarBase *menubar);
+
+    void SetLayoutDirection(const wxLayoutDirection dir);
+    wxLayoutDirection GetLayoutDirection() const;
+
+    // TODO: virtual void SetTitle(const wxString& title);
+
+    // implementation
+    int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
+
+    // implementation GTK only
+    GtkWidget       *m_menu;  // GtkMenu
+    GtkWidget       *m_owner;
+    GtkAccelGroup   *m_accel;
+    bool m_popupShown;
+
+protected:
+    virtual wxMenuItem* DoAppend(wxMenuItem *item);
+    virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem* DoRemove(wxMenuItem *item);
+
+private:
+    // common code for all constructors:
+    void Init();
+
+    // common part of Append (if pos == -1)  and Insert
+    bool GtkAppend(wxMenuItem *item, int pos=-1);
+
+    GtkWidget *m_prevRadio;
+
+    DECLARE_DYNAMIC_CLASS(wxMenu)

 };
 
 };
 

-#endif // __GTKMENUH__
+#endif
+    // _WX_GTKMENU_H_