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 { return FindMenuItemById( id ); }
  53
  54   void Check( int id, bool check );
  55   bool Checked( int id ) const;
  56   void Enable( int id, bool enable );
  57   bool Enabled( int id ) const;
  58   inline bool IsEnabled( int id ) const { return Enabled(id); }
  59   inline bool IsChecked( int id ) const { return Checked(id); }
  60
  61   wxString GetLabel( int id ) const;
  62   void SetLabel( int id, const wxString &label );
  63
  64   void EnableTop( int pos, bool flag );
  65   void SetLabelTop( int pos, const wxString& label );
  66   wxString GetLabelTop( int pos ) const;
  67
  68   virtual void SetHelpString( int id, const wxString& helpString );
  69   virtual wxString GetHelpString( int id ) const;
  70
  71   inline int GetMenuCount() const { return m_menus.Number(); }
  72   inline wxMenu *GetMenu( int n ) const { return (wxMenu *)m_menus.Nth(n)->Data(); }
  73
  74   wxList       m_menus;
  75   GtkWidget   *m_menubar;
  76 };
  77
  78 //-----------------------------------------------------------------------------
  79 // wxMenu
  80 //-----------------------------------------------------------------------------
  81
  82 class wxMenu: public wxEvtHandler
  83 {
  84 DECLARE_DYNAMIC_CLASS(wxMenu)
  85
  86 public:
  87   // construction
  88   wxMenu( const wxString& title = wxEmptyString, const wxFunction func = (wxFunction) NULL );
  89
  90   // operations
  91     // title
  92   void SetTitle(const wxString& label);
  93   const wxString GetTitle() const;
  94     // menu creation
  95   void AppendSeparator();
  96   void Append(int id, const wxString &item,
  97               const wxString &helpStr = "", bool checkable = FALSE);
  98   void Append(int id, const wxString &item,
  99               wxMenu *subMenu, const wxString &helpStr = "" );
 100   void Break() {};
 101
 102     // find item by name/id
 103   int FindItem( const wxString itemString ) const;
 104   wxMenuItem *FindItem( int id ) const;
 105   wxMenuItem *FindItemForId( int id ) const { return FindItem( id ); }
 106
 107     // get/set item's state
 108   void Enable( int id, bool enable );
 109   bool IsEnabled( int id ) const;
 110   void Check( int id, bool check );
 111   bool IsChecked( int id ) const;
 112
 113   void SetLabel( int id, const wxString &label );
 114   wxString GetLabel( int id ) const;
 115
 116   // helpstring
 117   virtual void SetHelpString(int id, const wxString& helpString);
 118   virtual wxString GetHelpString(int id) const ;
 119
 120   // accessors
 121   wxList& GetItems() { return m_items; }
 122
 123   inline void Callback(const wxFunction func) { m_callback = func; }
 124
 125   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 126   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 127
 128   inline void SetClientData( void* clientData ) { m_clientData = clientData; }
 129   inline void* GetClientData() const { return m_clientData; }
 130
 131   // Updates the UI for a menu and all submenus recursively.
 132   // source is the object that has the update event handlers
 133   // defined for it. If NULL, the menu or associated window
 134   // will be used.
 135   void UpdateUI(wxEvtHandler* source = (wxEvtHandler*) NULL);
 136
 137 // implementation
 138
 139   int FindMenuIdByMenuItem( GtkWidget *menuItem ) const;
 140   void SetInvokingWindow( wxWindow *win );
 141   wxWindow *GetInvokingWindow();
 142
 143   wxString       m_title;
 144   wxList         m_items;
 145   wxWindow      *m_invokingWindow;
 146   wxFunction     m_callback;
 147   wxEvtHandler  *m_eventHandler;
 148   void          *m_clientData;
 149
 150   GtkWidget     *m_menu;  // GtkMenu
 151   GtkWidget     *m_owner;
 152 };
 153
 154 #endif // __GTKMENUH__