no real changes, just some cleanup

[wxWidgets.git] / include / wx / msw / menu.h

diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h
index 7c40f1ab0e8f43fc0fc87e39d84fd704d0218f69..18ab994c8f325c691d6c9eb67244001d8a9c5631 100644 (file)
--- a/include/wx/msw/menu.h
+++ b/include/wx/msw/menu.h
@@ -1,191 +1,234 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        menu.h
+// Name:        wx/msw/menu.h

 // Purpose:     wxMenu, wxMenuBar classes
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxMenu, wxMenuBar classes
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_
 #define _WX_MENU_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_
 #define _WX_MENU_H_
 

-#ifdef __GNUG__
-#pragma interface "menu.h"
+#if wxUSE_ACCEL
+    #include "wx/accel.h"
+    #include "wx/dynarray.h"
+
+    WX_DEFINE_EXPORTED_ARRAY_PTR(wxAcceleratorEntry *, wxAcceleratorArray);
+#endif // wxUSE_ACCEL
+
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+
+#if defined(__WXWINCE__) && wxUSE_TOOLBAR
+class WXDLLIMPEXP_FWD_CORE wxToolBar;

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/event.h"

 
 

-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenu;
+// Not using a combined wxToolBar/wxMenuBar? then use
+// a commandbar in WinCE .NET to implement the
+// menubar, since there is no ::SetMenu function.
+#if defined(__WXWINCE__)
+#   if ((_WIN32_WCE >= 400) && !defined(__POCKETPC__) && !defined(__SMARTPHONE__)) || \
+        defined(__HANDHELDPC__)
+#       define WINCE_WITH_COMMANDBAR
+#   else
+#       define WINCE_WITHOUT_COMMANDBAR
+#   endif
+#endif
+

 
 

-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+#include "wx/arrstr.h"

 
 // ----------------------------------------------------------------------------
 // Menu
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Menu
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxMenu: public wxEvtHandler
-{
-  DECLARE_DYNAMIC_CLASS(wxMenu)

 
 

+class WXDLLEXPORT wxMenu : public wxMenuBase
+{

 public:
 public:

-  // ctor & dtor
-  wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL);
-  ~wxMenu();
-
-  // construct menu
-    // append items to the menu
-      // separator line
-  void AppendSeparator();
-      // normal item
-  void Append(int id, const wxString& Label, const wxString& helpString = wxEmptyString,
-              bool checkable = FALSE);
-      // a submenu
-  void Append(int id, const wxString& Label, wxMenu *SubMenu,
-              const wxString& helpString = wxEmptyString);
-      // the most generic form (create wxMenuItem first and use it's functions)
-  void Append(wxMenuItem *pItem);
-    // insert a break in the menu
-  void Break();
-    // delete an item
-  void Delete(int id); /* If it's a submenu, menu is not destroyed. VZ: why? */
-
-  // Client data
-  inline void SetClientData(void* clientData) { m_clientData = clientData; }
-  inline void* GetClientData() const { return m_clientData; }
-
-  // menu item control
-  void Enable(int id, bool Flag);
-  bool Enabled(int id) const;
-  inline bool IsEnabled(int id) const { return Enabled(id); };
-  void Check(int id, bool Flag);
-  bool Checked(int id) const;
-  inline bool IsChecked(int id) const { return Checked(id); };
-
-  // item properties
-    // title
-  void SetTitle(const wxString& label);
-  const wxString GetTitle() const;
-    // label
-  void SetLabel(int id, const wxString& label);
-  wxString GetLabel(int id) const;
-    // help string
-  virtual void SetHelpString(int id, const wxString& helpString);
-  virtual wxString GetHelpString(int id) const ;
-
-  // find item
-    // Finds the item id matching the given string, wxNOT_FOUND if not found.
-  virtual int FindItem(const wxString& itemString) const ;
-    // Find wxMenuItem by ID, and item's menu too if itemMenu is !NULL.
-  wxMenuItem *FindItemForId(int itemId, wxMenu **itemMenu = NULL) const;
-
-  // Updates the UI for a menu and all submenus recursively.
-  // source is the object that has the update event handlers
-  // defined for it. If NULL, the menu or associated window
-  // will be used.
-  void UpdateUI(wxEvtHandler* source = (wxEvtHandler*) NULL);
-
-  void ProcessCommand(wxCommandEvent& event);
-  inline void Callback(const wxFunction func) { m_callback = func; }
-
-  virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
-  inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-  inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-  inline wxList& GetItems() const { return (wxList&) m_menuItems; }
-
-  // IMPLEMENTATION
-  bool MSWCommand(WXUINT param, WXWORD id);
-
-  void      SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
-  wxWindow *GetInvokingWindow()         const { return m_pInvokingWindow; }
-
-  // semi-private accessors
-    // get the window which contains this menu
-  wxWindow *GetWindow() const;
-    // get the menu handle
-  WXHMENU GetHMenu() const;
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }
+
+    wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
+
+    virtual ~wxMenu();
+
+    virtual void Break();
+
+    virtual void SetTitle(const wxString& title);
+
+    // implementation only from now on
+    // -------------------------------
+
+    virtual void Attach(wxMenuBarBase *menubar);
+
+    bool MSWCommand(WXUINT param, WXWORD id);
+
+    // semi-private accessors
+        // get the window which contains this menu
+    wxWindow *GetWindow() const;
+        // get the menu handle
+    WXHMENU GetHMenu() const { return m_hMenu; }
+
+#if wxUSE_ACCEL
+    // called by wxMenuBar to build its accel table from the accels of all menus
+    bool HasAccels() const { return !m_accels.IsEmpty(); }
+    size_t GetAccelCount() const { return m_accels.GetCount(); }
+    size_t CopyAccels(wxAcceleratorEntry *accels) const;
+
+    // called by wxMenuItem when its accels changes
+    void UpdateAccel(wxMenuItem *item);
+
+    // helper used by wxMenu itself (returns the index in m_accels)
+    int FindAccel(int id) const;
+#endif // wxUSE_ACCEL
+
+protected:
+    virtual wxMenuItem* DoAppend(wxMenuItem *item);
+    virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem* DoRemove(wxMenuItem *item);

 
 private:
 
 private:

-  bool              m_doBreak ;
+    // common part of all ctors
+    void Init();

 
 

-public:
-  // This is used when m_hMenu is NULL because we don't want to
-  // delete it in ~wxMenu (it's been added to a parent menu).
-  // But we'll still need the handle for other purposes.
-  // Might be better to have a flag saying whether it's deleteable or not.
-  WXHMENU           m_savehMenu ; // Used for Enable() on popup
-  WXHMENU           m_hMenu;
-  wxFunction        m_callback;
-
-  int               m_noItems;
-  wxString          m_title;
-  wxMenu *          m_topLevelMenu;
-  wxMenuBar *       m_menuBar;
-  wxList            m_menuItems;
-  wxEvtHandler *    m_parent;
-  wxEvtHandler *    m_eventHandler;
-  wxWindow         *m_pInvokingWindow;
-  void*             m_clientData;
+    // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
+    bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
+
+    // terminate the current radio group, if any
+    void EndRadioGroup();
+
+    // if true, insert a breal before appending the next item
+    bool m_doBreak;
+
+    // the position of the first item in the current radio group or -1
+    int m_startRadioGroup;
+
+    // the menu handle of this menu
+    WXHMENU m_hMenu;
+
+#if wxUSE_ACCEL
+    // the accelerators for our menu items
+    wxAcceleratorArray m_accels;
+#endif // wxUSE_ACCEL
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)

 };
 
 // ----------------------------------------------------------------------------
 // Menu Bar (a la Windows)
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------
 // Menu Bar (a la Windows)
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar: public wxEvtHandler
+
+class WXDLLEXPORT wxMenuInfo : public wxObject

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxMenuBar)
+public :
+    wxMenuInfo() { m_menu = NULL; }
+    virtual ~wxMenuInfo() { }
+
+    void Create( wxMenu *menu , const wxString &title )
+    { m_menu = menu; m_title = title; }
+    wxMenu* GetMenu() const { return m_menu; }
+    wxString GetTitle() const { return m_title; }
+private :
+    wxMenu *m_menu;
+    wxString m_title;
+
+    DECLARE_DYNAMIC_CLASS(wxMenuInfo)
+};
+
+WX_DECLARE_EXPORTED_LIST(wxMenuInfo, wxMenuInfoList );

 
 

+class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
+{

 public:
 public:

-  wxMenuBar();
-  wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
-  ~wxMenuBar();
-
-  void Append(wxMenu *menu, const wxString& title);
-  // Must only be used AFTER menu has been attached to frame,
-  // otherwise use individual menus to enable/disable items
-  void Enable(int Id, bool Flag);
-  bool Enabled(int Id) const ;
-  inline bool IsEnabled(int Id) const { return Enabled(Id); };
-  void EnableTop(int pos, bool Flag);
-  void Check(int id, bool Flag);
-  bool Checked(int id) const ;
-  inline bool IsChecked(int Id) const { return Checked(Id); };
-  void SetLabel(int id, const wxString& label) ;
-  wxString GetLabel(int id) const ;
-  void SetLabelTop(int pos, const wxString& label) ;
-  wxString GetLabelTop(int pos) const ;
-  virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
-  virtual bool OnAppend(wxMenu *menu, const char *title);
-  virtual bool OnDelete(wxMenu *menu, int index);
-
-  virtual void SetHelpString(int Id, const wxString& helpString);
-  virtual wxString GetHelpString(int Id) const ;
-
-  virtual int FindMenuItem(const wxString& menuString, const wxString& itemString) const ;
-
-  // Find wxMenuItem for item ID, and return item's
-  // menu too if itemMenu is non-NULL.
-  wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const ;
-
-  inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-  inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-  inline int GetMenuCount() const { return m_menuCount; }
-  inline wxMenu* GetMenu(int i) const { return m_menus[i]; }
-
- public:
-  wxEvtHandler *            m_eventHandler;
-  int                       m_menuCount;
-  wxMenu **                 m_menus;
-  wxString *                m_titles;
-  wxFrame *                 m_menuBarFrame;
-  WXHMENU                   m_hMenu;
+    // ctors & dtor
+        // default constructor
+    wxMenuBar();
+        // unused under MSW
+    wxMenuBar(long style);
+        // menubar takes ownership of the menus arrays but copies the titles
+    wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);
+    virtual ~wxMenuBar();
+
+    // menubar construction
+    bool Append( wxMenuInfo *info ) { return Append( info->GetMenu() , info->GetTitle() ); }
+    const wxMenuInfoList& GetMenuInfos() const;
+
+    virtual bool Append( wxMenu *menu, const wxString &title );
+    virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
+    virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
+    virtual wxMenu *Remove(size_t pos);
+
+    virtual void EnableTop( size_t pos, bool flag );
+    virtual void SetMenuLabel( size_t pos, const wxString& label );
+    virtual wxString GetMenuLabel( size_t pos ) const;
+
+    // implementation from now on
+    WXHMENU Create();
+    virtual void Detach();
+    virtual void Attach(wxFrame *frame);
+
+#if defined(__WXWINCE__) && wxUSE_TOOLBAR
+    // Under WinCE, a menubar is owned by the frame's toolbar
+    void SetToolBar(wxToolBar* toolBar) { m_toolBar = toolBar; }
+    wxToolBar* GetToolBar() const { return m_toolBar; }
+#endif
+
+#ifdef WINCE_WITH_COMMANDBAR
+    WXHWND GetCommandBar() const { return m_commandBar; }
+    bool AddAdornments(long style);
+#endif
+
+#if wxUSE_ACCEL
+    // get the accel table for all the menus
+    const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
+
+    // update the accel table (must be called after adding/deleting a menu)
+    void RebuildAccelTable();
+#endif // wxUSE_ACCEL
+
+        // get the menu handle
+    WXHMENU GetHMenu() const { return m_hMenu; }
+
+    // if the menubar is modified, the display is not updated automatically,
+    // call this function to update it (m_menuBarFrame should be !NULL)
+    void Refresh();
+
+    // To avoid compile warning
+    void Refresh( bool eraseBackground,
+                          const wxRect *rect = (const wxRect *) NULL ) { wxWindow::Refresh(eraseBackground, rect); }
+
+protected:
+    // common part of all ctors
+    void Init();
+
+    wxArrayString m_titles;
+    wxMenuInfoList m_menuInfos;
+
+    WXHMENU       m_hMenu;
+
+    // Return the MSW position for a wxMenu which is sometimes different from
+    // the wxWidgets position.
+    int MSWPositionForWxMenu(wxMenu *menu, int wxpos);
+#if wxUSE_ACCEL
+    // the accelerator table for all accelerators in all our menus
+    wxAcceleratorTable m_accelTable;
+#endif // wxUSE_ACCEL
+
+#if defined(__WXWINCE__) && wxUSE_TOOLBAR
+    wxToolBar*  m_toolBar;
+#endif
+
+#ifdef WINCE_WITH_COMMANDBAR
+    WXHWND      m_commandBar;
+    bool        m_adornmentsAdded;
+#endif
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuBar)

 };
 
 #endif // _WX_MENU_H_
 };
 
 #endif // _WX_MENU_H_