X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e320a79f187558effb04d92020b470372bbe456..9869c26285dc51d13607cddaa04f65ce983653a5:/include/wx/os2/menu.h diff --git a/include/wx/os2/menu.h b/include/wx/os2/menu.h index db15f8fc70..a3a045bb1f 100644 --- a/include/wx/os2/menu.h +++ b/include/wx/os2/menu.h @@ -1,172 +1,291 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: menu.h +// Name: wx/os2/menu.h // Purpose: wxMenu, wxMenuBar classes -// Author: AUTHOR +// Author: David Webster // Modified by: -// Created: ??/??/98 -// RCS-ID: $Id$ -// Copyright: (c) AUTHOR -// Licence: wxWindows licence +// Created: 10/10/99 +// Copyright: (c) David Webster +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_MENU_H_ #define _WX_MENU_H_ -#ifdef __GNUG__ -#pragma interface "menu.h" -#endif +#if wxUSE_ACCEL + #include "wx/accel.h" + #include "wx/list.h" // for "template" list classes + #include "wx/dynarray.h" -#include "wx/defs.h" -#include "wx/event.h" + WX_DEFINE_EXPORTED_ARRAY_PTR(wxAcceleratorEntry *, wxAcceleratorArray); +#endif // wxUSE_ACCEL -class WXDLLEXPORT wxMenuItem; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxMenu; +class WXDLLIMPEXP_FWD_CORE wxFrame; -WXDLLEXPORT_DATA(extern const char*) wxEmptyString; +void wxSetShortCutKey(wxChar* zText); // ---------------------------------------------------------------------------- // Menu // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenu: public wxEvtHandler -{ - DECLARE_DYNAMIC_CLASS(wxMenu) +class WXDLLIMPEXP_CORE wxMenu : public wxMenuBase +{ 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); - - // 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 IsChecked(id); }; - - // Client data - inline void SetClientData(void* clientData) { m_clientData = clientData; } - inline void* GetClientData() const { return m_clientData; } - - void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; } - wxWindow *GetInvokingWindow() const { return m_pInvokingWindow; } - - // 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, -1 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; - - void ProcessCommand(wxCommandEvent& event); - inline void Callback(const wxFunction func) { m_callback = func; } - - // 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); - - 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; } + // + // Ctors & dtor + // + wxMenu( const wxString& rTitle + ,long lStyle = 0 + ) + : wxMenuBase( rTitle + ,lStyle + ) + { + Init(); + } -public: - wxFunction m_callback; - - int m_noItems; - wxString m_title; - wxMenuBar * m_menuBar; - wxList m_menuItems; - wxEvtHandler * m_parent; - wxEvtHandler * m_eventHandler; - void* m_clientData; - wxWindow* m_pInvokingWindow; -}; + wxMenu(long lStyle = 0) + : wxMenuBase(lStyle) + { + Init(); + } + + virtual ~wxMenu(); + + // + // 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 + // + // 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 + // + // 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: + // + // 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 + // + // The accelerators for our menu items + // + wxAcceleratorArray m_vAccels; +#endif // wxUSE_ACCEL + + DECLARE_DYNAMIC_CLASS(wxMenu) +}; // end of wxMenu // ---------------------------------------------------------------------------- // Menu Bar (a la Windows) // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFrame; -class WXDLLEXPORT wxMenuBar: public wxEvtHandler + +class WXDLLIMPEXP_CORE wxMenuBar : public wxMenuBarBase { - DECLARE_DYNAMIC_CLASS(wxMenuBar) - - 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; -/* TODO: data that represents the actual menubar when created. - */ +public: + // + // Ctors & dtor + // + + // + // Default constructor + // + wxMenuBar(); + + // + // 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[] + ,long lStyle = 0 + ); + virtual ~wxMenuBar(); + + // + // 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 SetMenuLabel( size_t nPos + ,const wxString& rLabel + ); + virtual wxString GetMenuLabel(size_t nPos) const; + + // + // Implementation from now on + // + WXHMENU Create(void); + virtual void Detach(void); + virtual void Attach(wxFrame* pFrame); + +#if wxUSE_ACCEL + // + // 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/deleting a menu) + // + void RebuildAccelTable(void); +#endif // wxUSE_ACCEL + + // + // Get the menu handle + WXHMENU GetHMenu(void) 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(void); + +protected: + // + // Common part of all ctors + // + void Init(void); + + wxArrayString m_titles; + + WXHMENU m_hMenu; + +#if wxUSE_ACCEL + // + // The accelerator table for all accelerators in all our menus + // + wxAcceleratorTable m_vAccelTable; +#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_