cell attributes added (doesn't quite work, work in progress, beware, don't use, ...

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

diff --git a/include/wx/os2/menu.h b/include/wx/os2/menu.h
index fd07f0fb9e002428c00a308dcc1bdc87a3eac724..6719c9e563143170a8cc3c45ac763804184bf7f3 100644 (file)
--- a/include/wx/os2/menu.h
+++ b/include/wx/os2/menu.h
@@ -12,285 +12,177 @@
 #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/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;
-

 // ----------------------------------------------------------------------------
 // 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)
-    {
-        Init(title, func);
-    }
-
-    wxMenu( long WXUNUSED(style) )
-    {
-        Init( wxEmptyString );
-    }
+    // ctors & dtor
+    wxMenu(const wxString& title, long style = 0)
+        : wxMenuBase(title, style) { Init(); }

 
 

-    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
-    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);
+    // implement base class virtuals
+    virtual bool DoAppend(wxMenuItem *item);
+    virtual bool DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem *DoRemove(wxMenuItem *item);
+
+    virtual void Break();
+
+    virtual void SetTitle(const wxString& title);

 
 

+    // OS2-specific

     bool ProcessCommand(wxCommandEvent& event);
 
     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; }
+#if WXWIN_COMPATIBILITY
+    wxMenu(const wxString& title, const wxFunction func)
+        : wxMenuBase(title)
+    {
+        Callback(func);
+    }
+#endif // WXWIN_COMPATIBILITY
+
+    // implementation only from now on
+    // -------------------------------

 
 

-    // IMPLEMENTATION

     bool OS2Command(WXUINT param, WXWORD id);
 
     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
     // semi-private accessors
         // get the window which contains this menu
     wxWindow *GetWindow() const;
         // get the menu handle

-    WXHMENU GetHMenu() const;
+    WXHMENU GetHMenu() const { return m_hMenu; }

 
 

-    // only for wxMenuBar
+    // attach/detach menu to/from wxMenuBar

     void Attach(wxMenuBar *menubar);
     void Detach();
 
 #if wxUSE_ACCEL
     void Attach(wxMenuBar *menubar);
     void Detach();
 
 #if wxUSE_ACCEL

-    inline size_t GetAccelCount() const { return m_accelKeyCodes.GetCount(); }
+    // 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;

-#endif // wxUSE_ACCEL

 
 

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

 
 

-#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
+    // helper used by wxMenu itself (returns the index in m_accels)
+    int FindAccel(int id) const;
+#endif // wxUSE_ACCEL

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

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

 #endif // wxUSE_ACCEL
 #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
     wxMenuBar();
 public:
     // ctors & dtor
         // default constructor
     wxMenuBar();

-        // unused under MSW
+        // unused under OS2

     wxMenuBar(long style);
         // menubar takes ownership of the menus arrays but copies the titles
     wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
     virtual ~wxMenuBar();
 
     // menubar construction
     wxMenuBar(long style);
         // menubar takes ownership of the menus arrays but copies the titles
     wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
     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 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 int FindMenuItem(const wxString& menuString,
                              const wxString& itemString) const;
     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]; }
+    virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;

 
 

-    inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
-    inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+    virtual void EnableTop( size_t pos, bool flag );
+    virtual void SetLabelTop( size_t pos, const wxString& label );
+    virtual wxString GetLabelTop( size_t pos ) const;

 
 

-#ifdef WXWIN_COMPATIBILITY

     // compatibility: these functions are deprecated
     // compatibility: these functions are deprecated

-    inline bool Enabled(int id) const { return IsEnabled(id); }
-    inline bool Checked(int id) const { return IsChecked(id); }
+#if 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
 
 #endif // WXWIN_COMPATIBILITY
 

-    // IMPLEMENTATION
+    // implementation from now on
+    WXHMENU Create();
+    int  FindMenu(const wxString& title);
+    void Detach();
+

         // returns TRUE if we're attached to a frame
         // returns TRUE if we're attached to a frame

-    inline bool IsAttached() const { return m_menuBarFrame != NULL; }
+    bool IsAttached() const { return m_menuBarFrame != NULL; }

         // get the frame we live in
         // get the frame we live in

-    inline wxFrame *GetFrame() const { return m_menuBarFrame; }
+    wxFrame *GetFrame() const { return m_menuBarFrame; }

         // attach to a frame
     void Attach(wxFrame *frame);
 
 #if wxUSE_ACCEL
         // attach to a frame
     void Attach(wxFrame *frame);
 
 #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() 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
 #endif // wxUSE_ACCEL
 
         // get the menu handle

-    inline WXHMENU GetHMenu() const { return m_hMenu; }
+    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)
 
     // if the menubar is modified, the display is not updated automatically,
     // call this function to update it (m_menuBarFrame should be !NULL)

-    void Refresh();
+    void Refresh( bool eraseBackground = TRUE
+                 ,const wxRect *rect = (const wxRect *) NULL
+                );

 
 protected:
     // common part of all ctors
     void Init();
 
 
 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;
+#endif // WXWIN_COMPATIBILITY
+
+    wxArrayString m_titles;
+

     wxFrame      *m_menuBarFrame;
     WXHMENU       m_hMenu;
 
     wxFrame      *m_menuBarFrame;
     WXHMENU       m_hMenu;
 


@@ -298,6 +190,9 @@ protected:
     // the accelerator table for all accelerators in all our menus
     wxAcceleratorTable m_accelTable;
 #endif // wxUSE_ACCEL
     // 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_