Remove SetPageTitle and GetPageTitle and make GetCurrentTitle actually return the...

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

diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h
index 4c4ecc86400633e4eeb5d5fcb90594be27e682f1..4c5e95f5ad2fece2044ea313e3c04e5f1adb351f 100644 (file)
--- a/include/wx/msw/menu.h
+++ b/include/wx/msw/menu.h
@@ -1,203 +1,169 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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"
-#endif
-
-#include "wx/defs.h"
-#include "wx/event.h"
-#include "wx/dynarray.h"
-#include "wx/string.h"
-

 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #if wxUSE_ACCEL
     #include "wx/accel.h"

+    #include "wx/dynarray.h"
+
+    WX_DEFINE_EXPORTED_ARRAY_PTR(wxAcceleratorEntry *, wxAcceleratorArray);

 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_ACCEL
 

-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenu;
-class WXDLLEXPORT wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+
+#if defined(__WXWINCE__) && wxUSE_TOOLBAR
+class WXDLLIMPEXP_FWD_CORE wxToolBar;
+#endif
+
+class wxMenuRadioItemsData;
+
+// 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 wxChar*) wxEmptyString;

 
 

-WX_DEFINE_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
+#include "wx/arrstr.h"

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

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

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMenu)
-

 public:
     // ctors & dtor
 public:
     // ctors & dtor

-    wxMenu(const wxString& title,
-           const wxFunction func)
-    {
-        Init(title, func);
-    }
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }

 
 

-    wxMenu( long WXUNUSED(style) )
-    {
-        Init( wxEmptyString );
-    }
-
-    wxMenu(const wxString& title = wxEmptyString, long WXUNUSED(style) = 0)
-    {
-        Init(title);
-    }
+    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; }
-
-    // IMPLEMENTATION
-    bool MSWCommand(WXUINT param, WXWORD id);
+    virtual void Break();

 
 

-    void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
-    wxWindow *GetInvokingWindow() const { return m_pInvokingWindow; }
+    virtual void SetTitle(const wxString& title);

 
 

-    // semi-private accessors
-        // get the window which contains this menu
-    wxWindow *GetWindow() const;
-        // get the menu handle
-    WXHMENU GetHMenu() const;
+    // implementation only from now on
+    // -------------------------------
+
+    bool MSWCommand(WXUINT param, WXWORD id);
+
+    // get the native menu handle
+    WXHMENU GetHMenu() const { return m_hMenu; }

 
 

-    // only for wxMenuBar
-    void Attach(wxMenuBar *menubar);
-    void Detach();
+    // Return the start and end position of the radio group to which the item
+    // at the given position belongs. Returns false if there is no radio group
+    // containing this position.
+    bool MSWGetRadioGroupRange(int pos, int *start, int *end) const;

 
 #if wxUSE_ACCEL
 
 #if wxUSE_ACCEL

-    size_t GetAccelCount() const { return m_accels.GetCount(); }
+    // called by wxMenuBar to build its accel table from the accels of all menus
+    bool HasAccels() const { return !m_accels.empty(); }
+    size_t GetAccelCount() const { return m_accels.size(); }

     size_t CopyAccels(wxAcceleratorEntry *accels) const;
     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;
+
+    // used only by wxMDIParentFrame currently but could be useful elsewhere:
+    // returns a new accelerator table with accelerators for just this menu
+    // (shouldn't be called if we don't have any accelerators)
+    wxAcceleratorTable *CreateAccelTable() const;

 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_ACCEL
 

-    wxFunction GetCallback() const { return m_callback; }
-    void Callback(const wxFunction func) { m_callback = func; }
-    wxFunction        m_callback;
+#if wxUSE_OWNER_DRAWN
+
+    int GetMaxAccelWidth()
+    {
+        if (m_maxAccelWidth == -1)
+            CalculateMaxAccelWidth();
+        return m_maxAccelWidth;
+    }
+
+    void ResetMaxAccelWidth()
+    {
+        m_maxAccelWidth = -1;
+    }
+
+    // get the menu with given handle (recursively)
+    wxMenu* MSWGetMenu(WXHMENU hMenu);
+
+private:
+    void CalculateMaxAccelWidth();

 
 

-#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 // wxUSE_OWNER_DRAWN

 
 

-#endif // WXWIN_COMPATIBILITY
+protected:
+    virtual wxMenuItem* DoAppend(wxMenuItem *item);
+    virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem* DoRemove(wxMenuItem *item);

 
 private:
     // common part of all ctors
 
 private:
     // common part of all ctors

-    void Init(const wxString& title, const wxFunction func = NULL );
-
-    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;
+    void Init();
+
+    // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
+    bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
+
+
+    // This variable contains the description of the radio item groups and
+    // allows to find whether an item at the given position is part of the
+    // group and also where its group starts and ends.
+    //
+    // It is initially NULL and only allocated if we have any radio items.
+    wxMenuRadioItemsData *m_radioData;
+
+    // if true, insert a breal before appending the next item
+    bool m_doBreak;
+
+    // the menu handle of this menu
+    WXHMENU m_hMenu;

 
 #if wxUSE_ACCEL
     // the accelerators for our menu items
     wxAcceleratorArray m_accels;
 #endif // wxUSE_ACCEL
 
 #if wxUSE_ACCEL
     // the accelerators for our menu items
     wxAcceleratorArray m_accels;
 #endif // wxUSE_ACCEL

+
+#if wxUSE_OWNER_DRAWN
+    // true if the menu has any ownerdrawn items
+    bool m_ownerDrawn;
+
+    // the max width of menu items bitmaps
+    int m_maxBitmapWidth;
+
+    // the max width of menu items accels
+    int m_maxAccelWidth;
+#endif // wxUSE_OWNER_DRAWN
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)

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

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

 {
 public:
     // ctors & dtor
 {
 public:
     // ctors & dtor


@@ -206,7 +172,7 @@ public:
         // unused under MSW
     wxMenuBar(long style);
         // menubar takes ownership of the menus arrays but copies the titles
         // unused under MSW
     wxMenuBar(long style);
         // menubar takes ownership of the menus arrays but copies the titles

-    wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
+    wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);

     virtual ~wxMenuBar();
 
     // menubar construction
     virtual ~wxMenuBar();
 
     // menubar construction


@@ -215,43 +181,29 @@ public:
     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
     virtual wxMenu *Remove(size_t pos);
 
     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
     virtual wxMenu *Remove(size_t pos);
 

-    virtual int FindMenuItem(const wxString& menuString,
-                             const wxString& itemString) const;
-    virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;
-

     virtual void EnableTop( size_t pos, bool flag );
     virtual void EnableTop( size_t pos, bool flag );

-    virtual void SetLabelTop( size_t pos, const wxString& label );
-    virtual wxString GetLabelTop( size_t pos ) const;
-
-    // notifications: return FALSE to prevent the menu from being
-    // appended/deleted
-    virtual bool OnAppend(wxMenu *menu, const wxChar *title);
-    virtual bool OnDelete(wxMenu *menu, int index);
-
-    // compatibility: these functions are deprecated
-#ifdef WXWIN_COMPATIBILITY
-    void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-    wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-    bool Enabled(int id) const { return IsEnabled(id); }
-    bool Checked(int id) const { return IsChecked(id); }
-#endif // WXWIN_COMPATIBILITY
+    virtual void SetMenuLabel( size_t pos, const wxString& label );
+    virtual wxString GetMenuLabel( size_t pos ) const;

 
     // implementation from now on
     WXHMENU Create();
 
     // implementation from now on
     WXHMENU Create();

-    int  FindMenu(const wxString& title);
-    void Detach();
+    virtual void Detach();
+    virtual void Attach(wxFrame *frame);

 
 

-        // 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);
+#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
 
 #if wxUSE_ACCEL

-        // get the accel table for 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
 #endif // wxUSE_ACCEL
 
         // get the menu handle


@@ -261,26 +213,34 @@ public:
     // call this function to update it (m_menuBarFrame should be !NULL)
     void Refresh();
 
     // 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); }
+
+    // get the menu with given handle (recursively)
+    wxMenu* MSWGetMenu(WXHMENU hMenu);
+

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

-#ifdef WXWIN_COMPATIBILITY
-    wxEvtHandler *m_eventHandler;
-#endif // WXWIN_COMPATIBILITY
+    WXHMENU       m_hMenu;

 
 

-    wxArrayString m_titles;
+    // Return the MSW position for a wxMenu which is sometimes different from
+    // the wxWidgets position.
+    int MSWPositionForWxMenu(wxMenu *menu, int wxpos);

 
 

-    wxFrame      *m_menuBarFrame;
-    WXHMENU       m_hMenu;
+#if defined(__WXWINCE__) && wxUSE_TOOLBAR
+    wxToolBar*  m_toolBar;
+#endif

 
 

-#if wxUSE_ACCEL
-    // the accelerator table for all accelerators in all our menus
-    wxAcceleratorTable m_accelTable;
-#endif // wxUSE_ACCEL
+#ifdef WINCE_WITH_COMMANDBAR
+    WXHWND      m_commandBar;
+    bool        m_adornmentsAdded;
+#endif

 
 private:
 
 private:

-    DECLARE_DYNAMIC_CLASS(wxMenuBar)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuBar)

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