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 void wxSetShortCutKey(wxChar* zText);
  25
  26 // ----------------------------------------------------------------------------
  27 // Menu
  28 // ----------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxMenu : public wxMenuBase
  31 {
  32 public:
  33     //
  34     // Ctors & dtor
  35     //
  36     wxMenu( const wxString& rTitle
  37            ,long            lStyle = 0
  38           )
  39           : wxMenuBase( rTitle
  40                        ,lStyle
  41                       )
  42     {
  43         Init();
  44     }
  45
  46     wxMenu(long lStyle = 0)
  47           : wxMenuBase(lStyle)
  48     {
  49         Init();
  50     }
  51
  52     virtual ~wxMenu();
  53
  54     //
  55     // Implement base class virtuals
  56     //
  57     virtual bool        DoAppend(wxMenuItem* pItem);
  58     virtual bool        DoInsert( size_t      nPos
  59                                  ,wxMenuItem* pItem
  60                                 );
  61     virtual wxMenuItem* DoRemove(wxMenuItem* pItem);
  62     virtual void        Break(void);
  63     virtual void        SetTitle(const wxString& rTitle);
  64
  65 #if wxUSE_MENU_CALLBACK
  66     wxMenu( const wxString&  rTitle
  67            ,const wxFunction fnFunc
  68           )
  69           : wxMenuBase(rTitle)
  70     {
  71         Init();
  72         Callback(fnFunc);
  73     }
  74 #endif // wxUSE_MENU_CALLBACK
  75
  76     //
  77     // OS2-specific
  78     //
  79     bool ProcessCommand(wxCommandEvent& rEvent);
  80
  81
  82     //
  83     // Implementation only from now on
  84     // -------------------------------
  85     //
  86     bool OS2Command( WXUINT uParam
  87                     ,WXWORD wId
  88                    );
  89
  90     //
  91     // Semi-private accessors
  92     //
  93
  94     //
  95     // Get the window which contains this menu
  96     //
  97     wxWindow* GetWindow(void) const;
  98
  99     //
 100     // Get the menu handle
 101     //
 102     WXHMENU GetHMenu() const { return m_hMenu; }
 103
 104     //
 105     // Attach/detach menu to/from wxMenuBar
 106     //
 107     void Attach(wxMenuBar* pMenubar);
 108     void Detach(void);
 109
 110 #if wxUSE_ACCEL
 111     //
 112     // Called by wxMenuBar to build its accel table from the accels of all menus
 113     //
 114     bool   HasAccels(void) const { return !m_vAccels.IsEmpty(); }
 115     size_t GetAccelCount(void) const { return m_vAccels.GetCount(); }
 116     size_t CopyAccels(wxAcceleratorEntry* pAccels) const;
 117
 118     //
 119     // Called by wxMenuItem when its accels changes
 120     //
 121     void UpdateAccel(wxMenuItem* pItem);
 122
 123     //
 124     // Helper used by wxMenu itself (returns the index in m_accels)
 125     //
 126     int FindAccel(int nId) const;
 127 #endif // wxUSE_ACCEL
 128
 129     //
 130     // All OS/2PM Menu's have one of these
 131     //
 132     MENUITEM                        m_vMenuData;
 133
 134 private:
 135     //
 136     // Common part of all ctors
 137     //
 138     void Init();
 139
 140     //
 141     // Common part of Append/Insert (behaves as Append is pos == (size_t)-1)
 142     //
 143     bool DoInsertOrAppend( wxMenuItem* pItem
 144                           ,size_t      nPos = (size_t)-1
 145                          );
 146
 147     //
 148     // If TRUE, insert a breal before appending the next item
 149     //
 150     bool                            m_bDoBreak;
 151
 152     //
 153     // The menu handle of this menu
 154     //
 155     WXHMENU                         m_hMenu;
 156
 157     //
 158     // The helper variable for creating unique IDs.
 159     //
 160     static USHORT                   m_nextMenuId;
 161
 162 #if wxUSE_ACCEL
 163     //
 164     // The accelerators for our menu items
 165     //
 166     wxAcceleratorArray              m_vAccels;
 167 #endif // wxUSE_ACCEL
 168
 169     DECLARE_DYNAMIC_CLASS(wxMenu)
 170 }; // end of wxMenu
 171
 172 // ----------------------------------------------------------------------------
 173 // Menu Bar (a la Windows)
 174 // ----------------------------------------------------------------------------
 175
 176 class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
 177 {
 178 public:
 179     //
 180     // Ctors & dtor
 181     //
 182
 183     //
 184     // Default constructor
 185     //
 186     wxMenuBar();
 187
 188     //
 189     // Unused under OS2
 190     wxMenuBar(long lStyle);
 191
 192     //
 193     // Menubar takes ownership of the menus arrays but copies the titles
 194     //
 195     wxMenuBar( int            n
 196               ,wxMenu*        vMenus[]
 197               ,const wxString sTitles[]
 198              );
 199     virtual ~wxMenuBar();
 200
 201     //
 202     // Menubar construction
 203     //
 204     virtual bool        Append( wxMenu*         pMenu
 205                                ,const wxString& rTitle
 206                               );
 207     virtual bool        Insert( size_t          nPos
 208                                ,wxMenu*         pMenu
 209                                ,const wxString& rTitle
 210                               );
 211     virtual wxMenu*     Replace( size_t          nPos
 212                                 ,wxMenu*         pMenu
 213                                 ,const wxString& rTitle
 214                                );
 215     virtual wxMenu*     Remove(size_t nPos);
 216     virtual int         FindMenuItem( const wxString& rMenuString
 217                                      ,const wxString& rItemString
 218                                     ) const;
 219     virtual wxMenuItem* FindItem( int      nId
 220                                  ,wxMenu** ppMenu = NULL
 221                                 ) const;
 222
 223     virtual void        EnableTop( size_t nPos
 224                                   ,bool   bFlag
 225                                  );
 226     virtual void        SetLabelTop( size_t          nPos
 227                                     ,const wxString& rLabel
 228                                    );
 229     virtual wxString    GetLabelTop(size_t nPos) const;
 230
 231     //
 232     // Compatibility: these functions are deprecated
 233     //
 234 #if WXWIN_COMPATIBILITY
 235     void          SetEventHandler(wxEvtHandler* pHandler) { m_pEventHandler = pHandler; }
 236     wxEvtHandler* GetEventHandler(void) { return m_pEventHandler; }
 237     bool          Enabled(int nId) const { return IsEnabled(nId); }
 238     bool          Checked(int nId) const { return IsChecked(nId); }
 239 #endif // WXWIN_COMPATIBILITY
 240
 241     //
 242     // Implementation from now on
 243     //
 244     WXHMENU                   Create(void);
 245     void                      Detach(void);
 246
 247     //
 248     // Returns TRUE if we're attached to a frame
 249     //
 250     bool                      IsAttached(void) const { return m_pMenuBarFrame != NULL; }
 251
 252     //
 253     // Get the frame we live in
 254     //
 255     wxFrame *                 GetFrame(void) const { return m_pMenuBarFrame; }
 256
 257     //
 258     // Attach to a frame
 259     //
 260     void                      Attach(wxFrame* pFrame);
 261
 262 #if wxUSE_ACCEL
 263     //
 264     // Get the accel table for all the menus
 265     //
 266     const wxAcceleratorTable& GetAccelTable(void) const { return m_vAccelTable; }
 267
 268     //
 269     // Update the accel table (must be called after adding/deletign a menu)
 270     //
 271     void                      RebuildAccelTable(void);
 272 #endif // wxUSE_ACCEL
 273
 274     //
 275     // Get the menu handle
 276     WXHMENU                   GetHMenu(void) const { return m_hMenu; }
 277
 278     //
 279     // If the menubar is modified, the display is not updated automatically,
 280     // call this function to update it (m_menuBarFrame should be !NULL)
 281     //
 282     void                      Refresh(void);
 283
 284 protected:
 285     //
 286     // Common part of all ctors
 287     //
 288     void                      Init(void);
 289
 290 #if WXWIN_COMPATIBILITY
 291     wxEvtHandler*                   m_pEventHandler;
 292 #endif // WXWIN_COMPATIBILITY
 293
 294     wxArrayString m_titles;
 295
 296     wxFrame*                        m_pMenuBarFrame;
 297     WXHMENU                         m_hMenu;
 298
 299 #if wxUSE_ACCEL
 300     //
 301     // The accelerator table for all accelerators in all our menus
 302     //
 303     wxAcceleratorTable              m_vAccelTable;
 304 #endif // wxUSE_ACCEL
 305
 306 private:
 307     //
 308     // Virtual function hiding suppression
 309     //
 310     void                      Refresh( bool          bErase
 311                                       ,const wxRect* pRect
 312                                      )
 313     { wxWindow::Refresh(bErase, pRect); }
 314
 315     DECLARE_DYNAMIC_CLASS(wxMenuBar)
 316 };
 317
 318 #endif // _WX_MENU_H_