include/wx/os2/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.h
   3 // Purpose:     wxMenu, wxMenuBar classes
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/10/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MENU_H_
  13 #define _WX_MENU_H_
  14
  15 #if wxUSE_ACCEL
  16     #include "wx/accel.h"
  17     #include "wx/dynarray.h"
  18
  19     WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
  20 #endif // wxUSE_ACCEL
  21
  22 class WXDLLEXPORT wxFrame;
  23
  24 // ----------------------------------------------------------------------------
  25 // Menu
  26 // ----------------------------------------------------------------------------
  27
  28 class WXDLLEXPORT wxMenu : public wxMenuBase
  29 {
  30 public:
  31     // ctors & dtor
  32     wxMenu(const wxString& title, long style = 0)
  33         : wxMenuBase(title, style) { Init(); }
  34
  35     wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
  36
  37     virtual ~wxMenu();
  38
  39     // implement base class virtuals
  40     virtual bool DoAppend(wxMenuItem *item);
  41     virtual bool DoInsert(size_t pos, wxMenuItem *item);
  42     virtual wxMenuItem *DoRemove(wxMenuItem *item);
  43
  44     virtual void Break();
  45
  46     virtual void SetTitle(const wxString& title);
  47
  48     // OS2-specific
  49     bool ProcessCommand(wxCommandEvent& event);
  50
  51 #if WXWIN_COMPATIBILITY
  52     wxMenu(const wxString& title, const wxFunction func)
  53         : wxMenuBase(title)
  54     {
  55         Callback(func);
  56     }
  57 #endif // WXWIN_COMPATIBILITY
  58
  59     // implementation only from now on
  60     // -------------------------------
  61
  62     bool OS2Command(WXUINT param, WXWORD id);
  63
  64     // semi-private accessors
  65         // get the window which contains this menu
  66     wxWindow *GetWindow() const;
  67         // get the menu handle
  68     WXHMENU GetHMenu() const { return m_hMenu; }
  69
  70     // attach/detach menu to/from wxMenuBar
  71     void Attach(wxMenuBar *menubar);
  72     void Detach();
  73
  74 #if wxUSE_ACCEL
  75     // called by wxMenuBar to build its accel table from the accels of all menus
  76     bool HasAccels() const { return !m_accels.IsEmpty(); }
  77     size_t GetAccelCount() const { return m_accels.GetCount(); }
  78     size_t CopyAccels(wxAcceleratorEntry *accels) const;
  79
  80     // called by wxMenuItem when its accels changes
  81     void UpdateAccel(wxMenuItem *item);
  82
  83     // helper used by wxMenu itself (returns the index in m_accels)
  84     int FindAccel(int id) const;
  85 #endif // wxUSE_ACCEL
  86
  87 private:
  88     // common part of all ctors
  89     void Init();
  90
  91     // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
  92     bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
  93
  94     // if TRUE, insert a breal before appending the next item
  95     bool m_doBreak;
  96
  97     // the menu handle of this menu
  98     WXHMENU m_hMenu;
  99
 100 #if wxUSE_ACCEL
 101     // the accelerators for our menu items
 102     wxAcceleratorArray m_accels;
 103 #endif // wxUSE_ACCEL
 104
 105     DECLARE_DYNAMIC_CLASS(wxMenu)
 106 };
 107
 108 // ----------------------------------------------------------------------------
 109 // Menu Bar (a la Windows)
 110 // ----------------------------------------------------------------------------
 111
 112 class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
 113 {
 114 public:
 115     // ctors & dtor
 116         // default constructor
 117     wxMenuBar();
 118         // unused under OS2
 119     wxMenuBar(long style);
 120         // menubar takes ownership of the menus arrays but copies the titles
 121     wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
 122     virtual ~wxMenuBar();
 123
 124     // menubar construction
 125     virtual bool Append( wxMenu *menu, const wxString &title );
 126     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 127     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 128     virtual wxMenu *Remove(size_t pos);
 129
 130     virtual int FindMenuItem(const wxString& menuString,
 131                              const wxString& itemString) const;
 132     virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;
 133
 134     virtual void EnableTop( size_t pos, bool flag );
 135     virtual void SetLabelTop( size_t pos, const wxString& label );
 136     virtual wxString GetLabelTop( size_t pos ) const;
 137
 138     // compatibility: these functions are deprecated
 139 #if WXWIN_COMPATIBILITY
 140     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 141     wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 142
 143     bool Enabled(int id) const { return IsEnabled(id); }
 144     bool Checked(int id) const { return IsChecked(id); }
 145 #endif // WXWIN_COMPATIBILITY
 146
 147     // implementation from now on
 148     WXHMENU Create();
 149     int  FindMenu(const wxString& title);
 150     void Detach();
 151
 152         // returns TRUE if we're attached to a frame
 153     bool IsAttached() const { return m_menuBarFrame != NULL; }
 154         // get the frame we live in
 155     wxFrame *GetFrame() const { return m_menuBarFrame; }
 156         // attach to a frame
 157     void Attach(wxFrame *frame);
 158
 159 #if wxUSE_ACCEL
 160     // get the accel table for all the menus
 161     const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
 162
 163     // update the accel table (must be called after adding/deletign a menu)
 164     void RebuildAccelTable();
 165 #endif // wxUSE_ACCEL
 166
 167         // get the menu handle
 168     WXHMENU       GetHMenu() const { return m_hMenu; }
 169     unsigned long GetMenubarId() const { return m_ulMenubarId; }
 170
 171     // if the menubar is modified, the display is not updated automatically,
 172     // call this function to update it (m_menuBarFrame should be !NULL)
 173     void Refresh( bool eraseBackground = TRUE
 174                  ,const wxRect *rect = (const wxRect *) NULL
 175                 );
 176
 177 protected:
 178     // common part of all ctors
 179     void Init();
 180
 181 #if WXWIN_COMPATIBILITY
 182     wxEvtHandler *m_eventHandler;
 183 #endif // WXWIN_COMPATIBILITY
 184
 185     wxArrayString m_titles;
 186
 187     wxFrame*                        m_menuBarFrame;
 188     WXHMENU                         m_hMenu;
 189     unsigned long                   m_ulMenubarId;
 190
 191 #if wxUSE_ACCEL
 192     // the accelerator table for all accelerators in all our menus
 193     wxAcceleratorTable m_accelTable;
 194 #endif // wxUSE_ACCEL
 195
 196 private:
 197     DECLARE_DYNAMIC_CLASS(wxMenuBar)
 198 };
 199
 200 #endif // _WX_MENU_H_