Make list consistent with tree in terms of Vetoed changes closing the inline edit...

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

diff --git a/include/wx/os2/menu.h b/include/wx/os2/menu.h
index fd07f0fb9e002428c00a308dcc1bdc87a3eac724..b088026c217d61bd3bcfbb1e0e3250747bd3ef12 100644 (file)
--- a/include/wx/os2/menu.h
+++ b/include/wx/os2/menu.h
@@ -12,292 +12,280 @@
 #ifndef _WX_MENU_H_
 #define _WX_MENU_H_
 
 #ifndef _WX_MENU_H_
 #define _WX_MENU_H_
 

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

 #if wxUSE_ACCEL
 #if wxUSE_ACCEL

-#include "wx/accel.h"
+    #include "wx/accel.h"
+    #include "wx/list.h"        // for "template" list classes
+    #include "wx/dynarray.h"
+
+    WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);

 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_ACCEL
 

-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxMenu;

 class WXDLLEXPORT wxFrame;
 
 class WXDLLEXPORT wxFrame;
 

-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+void wxSetShortCutKey(wxChar* zText);

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

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

 
 

+class WXDLLEXPORT wxMenu : public wxMenuBase
+{

 public:
 public:

-    wxMenu(const wxString& title,
-           const wxFunction func)
+    //
+    // Ctors & dtor
+    //
+    wxMenu( const wxString& rTitle
+           ,long            lStyle = 0
+          )
+          : wxMenuBase( rTitle
+                       ,lStyle
+                      )

     {
     {

-        Init(title, func);
+        Init();

     }
 
     }
 

-    wxMenu( long WXUNUSED(style) )
+    wxMenu(long lStyle = 0)
+          : wxMenuBase(lStyle)

     {
     {

-        Init( wxEmptyString );
-    }
-
-    wxMenu(const wxString& title = wxEmptyString, long WXUNUSED(style) = 0)
-    {
-        Init(title);
+        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
-    inline void SetClientData(void* clientData) { m_clientData = clientData; }
-    inline 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
-    inline 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
-    inline 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);
-
-    inline virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
-    inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-    inline wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
-
-    // IMPLEMENTATION
-    bool OS2Command(WXUINT param, WXWORD id);
-
-    inline void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
-    inline 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;
-
-    // only for wxMenuBar
-    void Attach(wxMenuBar *menubar);
-    void Detach();
+    //
+    // Implement base class virtuals
+    //
+    virtual wxMenuItem* DoAppend(wxMenuItem* pItem);
+    virtual wxMenuItem* DoInsert( size_t      nPos
+                                 ,wxMenuItem* pItem
+                                );
+    virtual wxMenuItem* DoRemove(wxMenuItem* pItem);
+    virtual void        Break(void);
+    virtual void        SetTitle(const wxString& rTitle);
+
+    //
+    // Implementation only from now on
+    // -------------------------------
+    //
+    virtual void Attach(wxMenuBarBase* pMenubar);
+
+    bool OS2Command( WXUINT uParam
+                    ,WXWORD wId
+                   );
+
+    //
+    // Semi-private accessors
+    //
+
+    //
+    // Get the window which contains this menu
+    //
+    wxWindow* GetWindow(void) const;
+
+    //
+    // Get the menu handle
+    //
+    WXHMENU GetHMenu() const { return m_hMenu; }

 
 #if wxUSE_ACCEL
 
 #if wxUSE_ACCEL

-    inline size_t GetAccelCount() const { return m_accelKeyCodes.GetCount(); }
-    size_t CopyAccels(wxAcceleratorEntry *accels) const;
+    //
+    // Called by wxMenuBar to build its accel table from the accels of all menus
+    //
+    bool   HasAccels(void) const { return m_vAccels.IsEmpty(); }
+    size_t GetAccelCount(void) const { return m_vAccels.GetCount(); }
+    size_t CopyAccels(wxAcceleratorEntry* pAccels) const;
+
+    //
+    // Called by wxMenuItem when its accels changes
+    //
+    void UpdateAccel(wxMenuItem* pItem);
+
+    //
+    // Helper used by wxMenu itself (returns the index in m_accels)
+    //
+    int FindAccel(int nId) const;

 #endif // wxUSE_ACCEL
 #endif // wxUSE_ACCEL

-
-    inline wxFunction GetCallback() const { return m_callback; }
-    inline void Callback(const wxFunction func) { m_callback = func; }
-    wxFunction        m_callback;
-
-#ifdef WXWIN_COMPATIBILITY
-    // compatibility: these functions are deprecated
-    inline bool Enabled(int id) const { return IsEnabled(id); }
-    inline bool Checked(int id) const { return IsChecked(id); }
-
-#endif // WXWIN_COMPATIBILITY
+    //
+    // OS/2 specific Find
+    //
+    wxMenuItem* FindItem(int id, ULONG hItem, wxMenu **menu = NULL) const;
+    //virtual function hiding suppression
+    int FindItem(const wxString& rsString) const
+    { return wxMenuBase::FindItem(rsString); }
+    wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const
+    { return wxMenuBase::FindItem(id, menu); }
+
+    //
+    // All OS/2PM Menu's have one of these
+    //
+    MENUITEM                        m_vMenuData;

 
 private:
 
 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;
+    //
+    // Common part of all ctors
+    //
+    void Init();
+
+    //
+    // Common part of Append/Insert (behaves as Append is pos == (size_t)-1)
+    //
+    bool DoInsertOrAppend( wxMenuItem* pItem
+                          ,size_t      nPos = (size_t)-1
+                         );
+
+    //
+    // Terminate the current radio group, if any
+    //
+    void EndRadioGroup(void);
+
+    //
+    // If TRUE, insert a breal before appending the next item
+    //
+    bool                            m_bDoBreak;
+
+    //
+    // The menu handle of this menu
+    //
+    WXHMENU                         m_hMenu;
+
+    //
+    // The helper variable for creating unique IDs.
+    //
+    static USHORT                   m_nextMenuId;
+
+    //
+    // The position of the first item in the current radio group or -1
+    //
+    int                             m_nStartRadioGroup;

 
 #if wxUSE_ACCEL
 
 #if wxUSE_ACCEL

-    // the accelerators data
-    wxArrayInt        m_accelKeyCodes, m_accelFlags, m_accelIds;
+    //
+    // The accelerators for our menu items
+    //
+    wxAcceleratorArray              m_vAccels;

 #endif // wxUSE_ACCEL
 #endif // wxUSE_ACCEL

-};
+
+    DECLARE_DYNAMIC_CLASS(wxMenu)
+}; // end of 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:
 public:

-    // ctors & dtor
-        // default constructor
+    //
+    // Ctors & dtor
+    //
+
+    //
+    // Default constructor
+    //

     wxMenuBar();
     wxMenuBar();

-        // 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[]);
+
+    //
+    // Unused under OS2
+    wxMenuBar(long lStyle);
+
+    //
+    // Menubar takes ownership of the menus arrays but copies the titles
+    //
+    wxMenuBar( int            n
+              ,wxMenu*        vMenus[]
+              ,const wxString sTitles[]
+             );

     virtual ~wxMenuBar();
 
     virtual ~wxMenuBar();
 

-    // menubar construction
-    WXHMENU Create();
-    void Append(wxMenu *menu, const wxString& title);
-    void Insert(int pos, wxMenu * menu, const wxString& title);
-    void ReplaceMenu(int pos, wxMenu * new_menu, const wxString& title);
-    int  FindMenu(const wxString& title);
-    void Detach();
-    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 wxChar *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
-    inline int GetMenuCount() const { return m_menuCount; }
-    inline wxMenu *GetMenu(int i) const { return m_menus[i]; }
-
-    inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-    inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
-
-#ifdef WXWIN_COMPATIBILITY
-    // compatibility: these functions are deprecated
-    inline bool Enabled(int id) const { return IsEnabled(id); }
-    inline bool Checked(int id) const { return IsChecked(id); }
-#endif // WXWIN_COMPATIBILITY
-
-    // IMPLEMENTATION
-        // returns TRUE if we're attached to a frame
-    inline bool IsAttached() const { return m_menuBarFrame != NULL; }
-        // get the frame we live in
-    inline wxFrame *GetFrame() const { return m_menuBarFrame; }
-        // attach to a frame
-    void Attach(wxFrame *frame);
+    //
+    // Menubar construction
+    //
+    virtual bool        Append( wxMenu*         pMenu
+                               ,const wxString& rTitle
+                              );
+    virtual bool        Insert( size_t          nPos
+                               ,wxMenu*         pMenu
+                               ,const wxString& rTitle
+                              );
+    virtual wxMenu*     Replace( size_t          nPos
+                                ,wxMenu*         pMenu
+                                ,const wxString& rTitle
+                               );
+    virtual wxMenu*     Remove(size_t nPos);
+    virtual int         FindMenuItem( const wxString& rMenuString
+                                     ,const wxString& rItemString
+                                    ) const;
+    virtual wxMenuItem* FindItem( int      nId
+                                 ,wxMenu** ppMenu = NULL
+                                ) const;
+    virtual wxMenuItem* FindItem( int      nId
+                                 ,ULONG    hItem
+                                 ,wxMenu** ppMenu = NULL
+                                ) const;
+    virtual void        EnableTop( size_t nPos
+                                  ,bool   bFlag
+                                 );
+    virtual void        SetLabelTop( size_t          nPos
+                                    ,const wxString& rLabel
+                                   );
+    virtual wxString    GetLabelTop(size_t nPos) const;
+
+    //
+    // Implementation from now on
+    //
+    WXHMENU                   Create(void);
+    virtual void              Detach(void);
+    virtual void              Attach(wxFrame* pFrame);

 
 #if wxUSE_ACCEL
 
 #if wxUSE_ACCEL

-        // get the accel table for the menus
-    inline const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
+    //
+    // Get the accel table for all the menus
+    //
+    const wxAcceleratorTable& GetAccelTable(void) const { return m_vAccelTable; }
+
+    //
+    // Update the accel table (must be called after adding/deletign a menu)
+    //
+    void                      RebuildAccelTable(void);

 #endif // wxUSE_ACCEL
 
 #endif // wxUSE_ACCEL
 

-        // get the menu handle
-    inline WXHMENU GetHMenu() const { return m_hMenu; }
+    //
+    // Get the menu handle
+    WXHMENU                   GetHMenu(void) const { return m_hMenu; }

 
 

-    // if the menubar is modified, the display is not updated automatically,
+    //
+    // If the menubar is modified, the display is not updated automatically,

     // call this function to update it (m_menuBarFrame should be !NULL)
     // call this function to update it (m_menuBarFrame should be !NULL)

-    void Refresh();
+    //
+    void                      Refresh(void);

 
 protected:
 
 protected:

-    // common part of all ctors
-    void Init();
+    //
+    // Common part of all ctors
+    //
+    void                      Init(void);
+
+    wxArrayString m_titles;

 
 

-    wxEvtHandler *m_eventHandler;
-    int           m_menuCount;
-    wxMenu      **m_menus;
-    wxString     *m_titles;
-    wxFrame      *m_menuBarFrame;
-    WXHMENU       m_hMenu;
+    WXHMENU                         m_hMenu;

 
 #if wxUSE_ACCEL
 
 #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_vAccelTable;

 #endif // wxUSE_ACCEL
 #endif // wxUSE_ACCEL

+
+private:
+    //
+    // Virtual function hiding suppression
+    //
+    void                      Refresh( bool          bErase
+                                      ,const wxRect* pRect
+                                     )
+    { wxWindow::Refresh(bErase, pRect); }
+
+    DECLARE_DYNAMIC_CLASS(wxMenuBar)

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