changed wxUSE_MS_HTML_HELP to 1 by default

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

diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h
index 82663872ef5e02b4007cce70643082389bd2b179..310586e498acc293c270c467a61a303f766a2ca0 100644 (file)
--- a/include/wx/msw/menu.h
+++ b/include/wx/msw/menu.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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)
 // Purpose:     wxMenu, wxMenuBar classes
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)


@@ -16,162 +16,109 @@
     #pragma interface "menu.h"
 #endif
 
     #pragma interface "menu.h"
 #endif
 

-#include "wx/defs.h"
-#include "wx/event.h"
-#include "wx/dynarray.h"
+#if wxUSE_ACCEL
+    #include "wx/accel.h"
+    #include "wx/dynarray.h"

 
 

-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenu;
-class WXDLLEXPORT wxFrame;
+    WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
+#endif // wxUSE_ACCEL

 
 

-WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
+class WXDLLEXPORT wxFrame;

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

-class WXDLLEXPORT wxMenu : public wxEvtHandler
+class WXDLLEXPORT wxMenu : public wxMenuBase

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMenu)
-

 public:
 public:

-    // ctor & dtor
-    wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL);
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }
+
+    wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
+

     virtual ~wxMenu();
 
     virtual ~wxMenu();
 

-    // construct menu
-        // append a separator to the menu
-    void AppendSeparator();
-        // append a normal item to the menu
-    void Append(int id, const wxString& label,
-                const wxString& helpString = wxEmptyString,
-                bool checkable = FALSE);
-        // append a submenu
-    void Append(int id, const wxString& label,
-                wxMenu *submenu,
-                const wxString& helpString = wxEmptyString);
-        // append anything (create wxMenuItem first)
-    void Append(wxMenuItem *pItem);
-
-        // insert a break in the menu
-    void Break();
-
-        // delete an item
-        // If it's a submenu, menu is not destroyed.
-        // VZ: why? shouldn't it return "wxMenu *" then?
-    void Delete(int id);
-
-    // client data
-    void SetClientData(void* clientData) { m_clientData = clientData; }
-    void* GetClientData() const { return m_clientData; }
-
-    // menu item control
-        // enable/disable item
-    void Enable(int id, bool enable);
-        // TRUE if enabled
-    bool IsEnabled(int id) const;
-
-        // check/uncheck item - only for checkable items, of course
-    void Check(int id, bool check);
-        // TRUE if checked
-    bool IsChecked(int id) const;
-
-    // other properties
-        // the menu title
-    void SetTitle(const wxString& label);
-    const wxString GetTitle() const;
-        // the item 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;
-
-        // get the list of items
-    wxList& GetItems() const { return (wxList &)m_menuItems; }
-
-    // find item
-        // returns id of the item matching the given string or wxNOT_FOUND
-    virtual int FindItem(const wxString& itemString) const;
-        // returns NULL if not found
-    wxMenuItem* FindItem(int id) const { return FindItemForId(id); }
-        // 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);
-
-    bool ProcessCommand(wxCommandEvent& event);
-
-    virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
-    void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-    wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
+    // implement base class virtuals
+    virtual bool DoAppend(wxMenuItem *item);
+    virtual bool DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem *DoRemove(wxMenuItem *item);

 
 

-    // IMPLEMENTATION
-    bool MSWCommand(WXUINT param, WXWORD id);
+    virtual void Break();
+
+    virtual void SetTitle(const wxString& title);
+
+    // deprecated functions
+#if wxUSE_MENU_CALLBACK
+    wxMenu(const wxString& title, const wxFunction func)
+        : wxMenuBase(title)
+    {
+        Init();

 
 

-    void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
-    wxWindow *GetInvokingWindow() const { return m_pInvokingWindow; }
+        Callback(func);
+    }
+#endif // wxUSE_MENU_CALLBACK
+
+    // 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
 
     // semi-private accessors
         // get the window which contains this menu
     wxWindow *GetWindow() const;
         // get the menu handle

-    WXHMENU GetHMenu() const;
-
-    // only for wxMenuBar
-    void Attach(wxMenuBar *menubar);
-    void Detach();
+    WXHMENU GetHMenu() const { return m_hMenu; }

 
 

-    size_t GetAccelCount() const { return m_accelKeyCodes.GetCount(); }
+#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;
 
     size_t CopyAccels(wxAcceleratorEntry *accels) const;
 

-#ifdef WXWIN_COMPATIBILITY
-    void Callback(const wxFunction func) { m_callback = func; }
+    // called by wxMenuItem when its accels changes
+    void UpdateAccel(wxMenuItem *item);

 
 

-    // compatibility: these functions are deprecated
-    bool Enabled(int id) const { return IsEnabled(id); }
-    bool Checked(int id) const { return IsChecked(id); }
+    // helper used by wxMenu itself (returns the index in m_accels)
+    int FindAccel(int id) const;
+#endif // wxUSE_ACCEL

 
 private:
 
 private:

-    wxFunction        m_callback;
-#endif // WXWIN_COMPATIBILITY
+    // common part of all ctors
+    void Init();

 
 

-private:
-    bool              m_doBreak;
-
-    // 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;
-
-    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;
-
-    // the accelerators data
-    wxArrayInt        m_accelKeyCodes, m_accelFlags, m_accelIds;
+    // 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(wxMenu)

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

-class WXDLLEXPORT wxMenuBar : public wxEvtHandler
+class WXDLLEXPORT wxMenuBar : public wxMenuBarBase

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMenuBar)
-

 public:
     // ctors & dtor
         // default constructor
 public:
     // ctors & dtor
         // default constructor


@@ -183,91 +130,63 @@ public:
     virtual ~wxMenuBar();
 
     // menubar construction
     virtual ~wxMenuBar();
 
     // menubar construction

-    WXHMENU Create();
-    void Append(wxMenu *menu, const wxString& title);
-    virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
-
-    // state control
-    // NB: must only be used AFTER menu has been attached to frame,
-    //     otherwise use individual menus to enable/disable items
-        // enable the item
-    void Enable(int id, bool enable);
-        // TRUE if item enabled
-    bool IsEnabled(int id) const;
-        //
-    void EnableTop(int pos, bool enable);
-
-        // works only with checkable items
-    void Check(int id, bool check);
-        // TRUE if checked
-    bool IsChecked(int id) const;
-
-    void SetLabel(int id, const wxString& label) ;
-    wxString GetLabel(int id) const ;
-
-    virtual void SetHelpString(int id, const wxString& helpString);
-    virtual wxString GetHelpString(int id) const ;
-
-    void SetLabelTop(int pos, const wxString& label) ;
-    wxString GetLabelTop(int pos) const ;
-
-    // notifications: return FALSE to prevent the menu from being
-    // appended/deleted
-    virtual bool OnAppend(wxMenu *menu, const char *title);
-    virtual bool OnDelete(wxMenu *menu, int index);
-
-    // item search
-        // by menu and item names, returns wxNOT_FOUND if not found
-    virtual int FindMenuItem(const wxString& menuString,
-                             const wxString& itemString) const;
-        // returns NULL if not found
-    wxMenuItem* FindItem(int id) const { return FindItemForId(id); }
-        // returns NULL if not found, fills menuForItem if !NULL
-    wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const;
-
-    // submenus access
-    int GetMenuCount() const { return m_menuCount; }
-    wxMenu *GetMenu(int i) const { return m_menus[i]; }
+    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 SetLabelTop( size_t pos, const wxString& label );
+    virtual wxString GetLabelTop( size_t pos ) const;
+
+    // compatibility: these functions are deprecated
+#if WXWIN_COMPATIBILITY

     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 
     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 

-#ifdef WXWIN_COMPATIBILITY
-    // compatibility: these functions are deprecated

     bool Enabled(int id) const { return IsEnabled(id); }
     bool Checked(int id) const { return IsChecked(id); }
 #endif // WXWIN_COMPATIBILITY
 
     bool Enabled(int id) const { return IsEnabled(id); }
     bool Checked(int id) const { return IsChecked(id); }
 #endif // WXWIN_COMPATIBILITY
 

-    // IMPLEMENTATION
-        // returns TRUE if we're attached to a frame
-    bool IsAttached() const { return m_menuBarFrame != NULL; }
-        // get the frame we live in
-    wxFrame *GetFrame() const { return m_menuBarFrame; }
-        // attach to a frame
-    void Attach(wxFrame *frame);
+    // implementation from now on
+    WXHMENU Create();
+    virtual void Detach();
+    virtual void Attach(wxFrame *frame);

 
 

-        // get the accel table for the menus
+#if wxUSE_ACCEL
+    // get the accel table for all the menus

     const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
     const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }

+
+    // update the accel table (must be called after adding/deletign a menu)
+    void RebuildAccelTable();
+#endif // wxUSE_ACCEL
+

         // get the menu handle
     WXHMENU GetHMenu() const { return m_hMenu; }
 
         // get the menu handle
     WXHMENU GetHMenu() const { return m_hMenu; }
 

-protected:
-    // common part of all ctors
-    void Init();
-

     // if the menubar is modified, the display is not updated automatically,
     // call this function to update it (m_menuBarFrame should be !NULL)
     void Refresh();
 
     // if the menubar is modified, the display is not updated automatically,
     // call this function to update it (m_menuBarFrame should be !NULL)
     void Refresh();
 

+protected:
+    // common part of all ctors
+    void Init();
+
+#if WXWIN_COMPATIBILITY

     wxEvtHandler *m_eventHandler;
     wxEvtHandler *m_eventHandler;

-    int           m_menuCount;
-    wxMenu      **m_menus;
-    wxString     *m_titles;
-    wxFrame      *m_menuBarFrame;
+#endif // WXWIN_COMPATIBILITY
+
+    wxArrayString m_titles;
+

     WXHMENU       m_hMenu;
 
     WXHMENU       m_hMenu;
 

+#if wxUSE_ACCEL

     // the accelerator table for all accelerators in all our menus
     wxAcceleratorTable m_accelTable;
     // the accelerator table for all accelerators in all our menus
     wxAcceleratorTable m_accelTable;

+#endif // wxUSE_ACCEL
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)

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