include/wx/gtk/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef __GTKMENUH__
  12 #define __GTKMENUH__
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/list.h"
  21 #include "wx/window.h"
  22 #include "wx/menuitem.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // classes
  26 //-----------------------------------------------------------------------------
  27
  28 class wxMenuBar;
  29 class wxMenuItem;
  30 class wxMenu;
  31
  32 //-----------------------------------------------------------------------------
  33 // const
  34 //-----------------------------------------------------------------------------
  35
  36 #define   ID_SEPARATOR    (-1)
  37
  38 //-----------------------------------------------------------------------------
  39 // wxMenuBar
  40 //-----------------------------------------------------------------------------
  41
  42 class wxMenuBar: public wxWindow
  43 {
  44 DECLARE_DYNAMIC_CLASS(wxMenuBar)
  45
  46 public:
  47   wxMenuBar();
  48   void Append( wxMenu *menu, const wxString &title );
  49
  50   int FindMenuItem( const wxString &menuString, const wxString &itemString ) const;
  51   wxMenuItem* FindMenuItemById( int id ) const;
  52   inline wxMenuItem* FindItemForId( int id ) const
  53     { return FindMenuItemById( id ); }
  54
  55   void Check( int id, bool check );
  56   bool Checked( int id ) const;
  57   void Enable( int id, bool enable );
  58   bool Enabled( int id ) const;
  59   inline bool IsEnabled(int Id) const { return Enabled(Id); };
  60   inline bool IsChecked(int Id) const { return Checked(Id); };
  61
  62   int     GetMenuCount() const { return m_menus.Number(); }
  63   wxMenu *GetMenu(int n) const { return (wxMenu *)m_menus.Nth(n)->Data(); }
  64
  65   wxList       m_menus;
  66   GtkWidget   *m_menubar;
  67 };
  68
  69 //-----------------------------------------------------------------------------
  70 // wxMenu
  71 //-----------------------------------------------------------------------------
  72
  73 class wxMenu: public wxEvtHandler
  74 {
  75 DECLARE_DYNAMIC_CLASS(wxMenu)
  76
  77 public:
  78   // construction
  79   wxMenu( const wxString& title = wxEmptyString, const wxFunction func = (wxFunction) NULL );
  80
  81   // operations
  82     // title
  83   void SetTitle(const wxString& label);
  84   const wxString GetTitle() const;
  85     // menu creation
  86   void AppendSeparator();
  87   void Append(int id, const wxString &item,
  88               const wxString &helpStr = "", bool checkable = FALSE);
  89   void Append(int id, const wxString &item,
  90               wxMenu *subMenu, const wxString &helpStr = "" );
  91   void Break() {};
  92
  93     // find item by name/id
  94   int FindItem( const wxString itemString ) const;
  95   wxMenuItem *FindItem( int id ) const;
  96   wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
  97
  98     // get/set item's state
  99   void Enable( int id, bool enable );
 100   bool IsEnabled( int id ) const;
 101   void Check( int id, bool check );
 102   bool IsChecked( int id ) const;
 103
 104   void SetLabel( int id, const wxString &label );
 105   wxString GetLabel(int id) const;
 106
 107   // helpstring
 108   virtual void SetHelpString(int id, const wxString& helpString);
 109   virtual wxString GetHelpString(int id) const ;
 110
 111   // accessors
 112   wxList& GetItems() { return m_items; }
 113
 114   inline void Callback(const wxFunction func) { m_callback = func; }
 115
 116   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 117   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 118
 119   inline void SetClientData( void* clientData ) { m_clientData = clientData; }
 120   inline void* GetClientData() const { return m_clientData; }
 121
 122 // implementation
 123
 124   int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
 125   void SetInvokingWindow( wxWindow *win );
 126   wxWindow *GetInvokingWindow();
 127
 128   wxString       m_title;
 129   wxList         m_items;
 130   wxWindow      *m_invokingWindow;
 131   wxFunction     m_callback;
 132   wxEvtHandler  *m_eventHandler;
 133   void          *m_clientData;
 134
 135   GtkWidget     *m_menu;  // GtkMenu
 136 };
 137
 138 #endif // __GTKMENUH__