include/wx/msw/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/menu.h
   3 // Purpose:     wxMenu, wxMenuBar classes
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   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_PTR(wxAcceleratorEntry *, wxAcceleratorArray);
  20 #endif // wxUSE_ACCEL
  21
  22 class WXDLLIMPEXP_FWD_CORE wxFrame;
  23
  24 #if defined(__WXWINCE__) && wxUSE_TOOLBAR
  25 class WXDLLIMPEXP_FWD_CORE wxToolBar;
  26 #endif
  27
  28
  29 // Not using a combined wxToolBar/wxMenuBar? then use
  30 // a commandbar in WinCE .NET to implement the
  31 // menubar, since there is no ::SetMenu function.
  32 #if defined(__WXWINCE__)
  33 #   if ((_WIN32_WCE >= 400) && !defined(__POCKETPC__) && !defined(__SMARTPHONE__)) || \
  34         defined(__HANDHELDPC__)
  35 #       define WINCE_WITH_COMMANDBAR
  36 #   else
  37 #       define WINCE_WITHOUT_COMMANDBAR
  38 #   endif
  39 #endif
  40
  41
  42 #include "wx/arrstr.h"
  43
  44 // ----------------------------------------------------------------------------
  45 // Menu
  46 // ----------------------------------------------------------------------------
  47
  48 class WXDLLIMPEXP_CORE wxMenu : public wxMenuBase
  49 {
  50 public:
  51     // ctors & dtor
  52     wxMenu(const wxString& title, long style = 0)
  53         : wxMenuBase(title, style) { Init(); }
  54
  55     wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
  56
  57     virtual ~wxMenu();
  58
  59     virtual void Break();
  60
  61     virtual void SetTitle(const wxString& title);
  62
  63     // implementation only from now on
  64     // -------------------------------
  65
  66     virtual void Attach(wxMenuBarBase *menubar);
  67
  68     bool MSWCommand(WXUINT param, WXWORD id);
  69
  70     // semi-private accessors
  71         // get the window which contains this menu
  72     wxWindow *GetWindow() const;
  73         // get the menu handle
  74     WXHMENU GetHMenu() const { return m_hMenu; }
  75
  76 #if wxUSE_ACCEL
  77     // called by wxMenuBar to build its accel table from the accels of all menus
  78     bool HasAccels() const { return !m_accels.empty(); }
  79     size_t GetAccelCount() const { return m_accels.size(); }
  80     size_t CopyAccels(wxAcceleratorEntry *accels) const;
  81
  82     // called by wxMenuItem when its accels changes
  83     void UpdateAccel(wxMenuItem *item);
  84
  85     // helper used by wxMenu itself (returns the index in m_accels)
  86     int FindAccel(int id) const;
  87
  88     // used only by wxMDIParentFrame currently but could be useful elsewhere:
  89     // returns a new accelerator table with accelerators for just this menu
  90     // (shouldn't be called if we don't have any accelerators)
  91     wxAcceleratorTable *CreateAccelTable() const;
  92 #endif // wxUSE_ACCEL
  93
  94 #if wxUSE_OWNER_DRAWN
  95
  96     int GetMaxAccelWidth()
  97     {
  98         if (m_maxAccelWidth == -1)
  99             CalculateMaxAccelWidth();
 100         return m_maxAccelWidth;
 101     }
 102
 103     void ResetMaxAccelWidth()
 104     {
 105         m_maxAccelWidth = -1;
 106     }
 107
 108 private:
 109     void CalculateMaxAccelWidth();
 110
 111 #endif // wxUSE_OWNER_DRAWN
 112
 113 protected:
 114     virtual wxMenuItem* DoAppend(wxMenuItem *item);
 115     virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
 116     virtual wxMenuItem* DoRemove(wxMenuItem *item);
 117
 118 private:
 119     // common part of all ctors
 120     void Init();
 121
 122     // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
 123     bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
 124
 125     // terminate the current radio group, if any
 126     void EndRadioGroup();
 127
 128     // if true, insert a breal before appending the next item
 129     bool m_doBreak;
 130
 131     // the position of the first item in the current radio group or -1
 132     int m_startRadioGroup;
 133
 134     // the menu handle of this menu
 135     WXHMENU m_hMenu;
 136
 137 #if wxUSE_ACCEL
 138     // the accelerators for our menu items
 139     wxAcceleratorArray m_accels;
 140 #endif // wxUSE_ACCEL
 141
 142 #if wxUSE_OWNER_DRAWN
 143     // true if the menu has any ownerdrawn items
 144     bool m_ownerDrawn;
 145
 146     // the max width of menu items bitmaps
 147     int m_maxBitmapWidth;
 148
 149     // the max width of menu items accels
 150     int m_maxAccelWidth;
 151 #endif // wxUSE_OWNER_DRAWN
 152
 153     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)
 154 };
 155
 156 // ----------------------------------------------------------------------------
 157 // Menu Bar (a la Windows)
 158 // ----------------------------------------------------------------------------
 159
 160 class WXDLLIMPEXP_CORE wxMenuInfo : public wxObject
 161 {
 162 public :
 163     wxMenuInfo() { m_menu = NULL; }
 164     virtual ~wxMenuInfo() { }
 165
 166     void Create( wxMenu *menu , const wxString &title )
 167     { m_menu = menu; m_title = title; }
 168     wxMenu* GetMenu() const { return m_menu; }
 169     wxString GetTitle() const { return m_title; }
 170 private :
 171     wxMenu *m_menu;
 172     wxString m_title;
 173
 174     DECLARE_DYNAMIC_CLASS(wxMenuInfo)
 175 };
 176
 177 WX_DECLARE_EXPORTED_LIST(wxMenuInfo, wxMenuInfoList );
 178
 179 class WXDLLIMPEXP_CORE wxMenuBar : public wxMenuBarBase
 180 {
 181 public:
 182     // ctors & dtor
 183         // default constructor
 184     wxMenuBar();
 185         // unused under MSW
 186     wxMenuBar(long style);
 187         // menubar takes ownership of the menus arrays but copies the titles
 188     wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);
 189     virtual ~wxMenuBar();
 190
 191     // menubar construction
 192     bool Append( wxMenuInfo *info ) { return Append( info->GetMenu() , info->GetTitle() ); }
 193     const wxMenuInfoList& GetMenuInfos() const;
 194
 195     virtual bool Append( wxMenu *menu, const wxString &title );
 196     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 197     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 198     virtual wxMenu *Remove(size_t pos);
 199
 200     virtual void EnableTop( size_t pos, bool flag );
 201     virtual void SetMenuLabel( size_t pos, const wxString& label );
 202     virtual wxString GetMenuLabel( size_t pos ) const;
 203
 204     // implementation from now on
 205     WXHMENU Create();
 206     virtual void Detach();
 207     virtual void Attach(wxFrame *frame);
 208
 209 #if defined(__WXWINCE__) && wxUSE_TOOLBAR
 210     // Under WinCE, a menubar is owned by the frame's toolbar
 211     void SetToolBar(wxToolBar* toolBar) { m_toolBar = toolBar; }
 212     wxToolBar* GetToolBar() const { return m_toolBar; }
 213 #endif
 214
 215 #ifdef WINCE_WITH_COMMANDBAR
 216     WXHWND GetCommandBar() const { return m_commandBar; }
 217     bool AddAdornments(long style);
 218 #endif
 219
 220 #if wxUSE_ACCEL
 221     // update the accel table (must be called after adding/deleting a menu)
 222     void RebuildAccelTable();
 223 #endif // wxUSE_ACCEL
 224
 225         // get the menu handle
 226     WXHMENU GetHMenu() const { return m_hMenu; }
 227
 228     // if the menubar is modified, the display is not updated automatically,
 229     // call this function to update it (m_menuBarFrame should be !NULL)
 230     void Refresh();
 231
 232     // To avoid compile warning
 233     void Refresh( bool eraseBackground,
 234                           const wxRect *rect = (const wxRect *) NULL ) { wxWindow::Refresh(eraseBackground, rect); }
 235
 236 protected:
 237     // common part of all ctors
 238     void Init();
 239
 240     wxArrayString m_titles;
 241     wxMenuInfoList m_menuInfos;
 242
 243     WXHMENU       m_hMenu;
 244
 245     // Return the MSW position for a wxMenu which is sometimes different from
 246     // the wxWidgets position.
 247     int MSWPositionForWxMenu(wxMenu *menu, int wxpos);
 248
 249 #if defined(__WXWINCE__) && wxUSE_TOOLBAR
 250     wxToolBar*  m_toolBar;
 251 #endif
 252
 253 #ifdef WINCE_WITH_COMMANDBAR
 254     WXHWND      m_commandBar;
 255     bool        m_adornmentsAdded;
 256 #endif
 257
 258 private:
 259     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuBar)
 260 };
 261
 262 #endif // _WX_MENU_H_