Fix for mistake with const for non pointer/reference with corrections in documentation.

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

diff --git a/include/wx/univ/menu.h b/include/wx/univ/menu.h
index 1e75af07633c65345c5b499b3b5837735b32b26b..e023830bf02743acff883e1e501b9e54dde7185d 100644 (file)
--- a/include/wx/univ/menu.h
+++ b/include/wx/univ/menu.h
@@ -12,10 +12,6 @@
 #ifndef _WX_UNIV_MENU_H_
 #define _WX_UNIV_MENU_H_
 
 #ifndef _WX_UNIV_MENU_H_
 #define _WX_UNIV_MENU_H_
 

-#ifdef __GNUG__
-    #pragma interface "univmenu.h"
-#endif
-

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


@@ -24,26 +20,12 @@
 
 // fwd declarations
 class WXDLLEXPORT wxMenuInfo;
 
 // fwd declarations
 class WXDLLEXPORT wxMenuInfo;

-WX_DECLARE_OBJARRAY(wxMenuInfo, wxMenuInfoArray);
-
-class wxPopupMenuWindow;
+WX_DECLARE_EXPORTED_OBJARRAY(wxMenuInfo, wxMenuInfoArray);

 
 

+class WXDLLEXPORT wxMenuGeometryInfo;
+class WXDLLEXPORT wxPopupMenuWindow;

 class WXDLLEXPORT wxRenderer;
 
 class WXDLLEXPORT wxRenderer;
 

-// ----------------------------------------------------------------------------
-// wxMenu helper classes, used in implementation only
-// ----------------------------------------------------------------------------
-
-// used by wxRenderer
-class WXDLLEXPORT wxMenuGeometryInfo
-{
-public:
-    // get the total size of the menu
-    virtual wxSize GetSize() const = 0;
-
-    virtual ~wxMenuGeometryInfo();
-};
-

 // ----------------------------------------------------------------------------
 // wxMenu
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxMenu
 // ----------------------------------------------------------------------------


@@ -68,7 +50,7 @@ public:
     // show this menu at the given position (in screen coords) and optionally
     // select its first item
     void Popup(const wxPoint& pos, const wxSize& size,
     // show this menu at the given position (in screen coords) and optionally
     // select its first item
     void Popup(const wxPoint& pos, const wxSize& size,

-               bool selectFirst = TRUE);
+               bool selectFirst = true);

 
     // dismiss the menu
     void Dismiss();
 
     // dismiss the menu
     void Dismiss();


@@ -79,11 +61,11 @@ public:
 
     // implementation only from here
 
 
     // implementation only from here
 

-    // do as if this item were clicked, return TRUE if the resulting event was
-    // processed, FALSE otherwise
+    // do as if this item were clicked, return true if the resulting event was
+    // processed, false otherwise

     bool ClickItem(wxMenuItem *item);
 
     bool ClickItem(wxMenuItem *item);
 

-    // process the key event, return TRUE if done
+    // process the key event, return true if done

     bool ProcessKeyDown(int key);
 
 #if wxUSE_ACCEL
     bool ProcessKeyDown(int key);
 
 #if wxUSE_ACCEL


@@ -93,9 +75,9 @@ public:
 
 protected:
     // implement base class virtuals
 
 protected:
     // implement base class virtuals

-    virtual bool DoAppend(wxMenuItem *item);
-    virtual bool DoInsert(size_t pos, wxMenuItem *item);
-    virtual wxMenuItem *DoRemove(wxMenuItem *item);
+    virtual wxMenuItem* DoAppend(wxMenuItem *item);
+    virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
+    virtual wxMenuItem* DoRemove(wxMenuItem *item);

 
     // common part of DoAppend and DoInsert
     void OnItemAdded(wxMenuItem *item);
 
     // common part of DoAppend and DoInsert
     void OnItemAdded(wxMenuItem *item);


@@ -129,6 +111,9 @@ private:
     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 

+    // terminate the current radio group, if any
+    void EndRadioGroup();
+

     // the exact menu geometry is defined by a struct derived from this one
     // which is opaque and defined by the renderer
     wxMenuGeometryInfo *m_geometry;
     // the exact menu geometry is defined by a struct derived from this one
     // which is opaque and defined by the renderer
     wxMenuGeometryInfo *m_geometry;


@@ -141,12 +126,11 @@ private:
     wxAcceleratorTable m_accelTable;
 #endif // wxUSE_ACCEL
 
     wxAcceleratorTable m_accelTable;
 #endif // wxUSE_ACCEL
 

+    // the position of the first item in the current radio group or -1
+    int m_startRadioGroup;
+

     // it calls out OnDismiss()
     // it calls out OnDismiss()

-#ifdef __WXMAC__

     friend class wxPopupMenuWindow;
     friend class wxPopupMenuWindow;

-#else
-    friend wxPopupMenuWindow;
-#endif

     DECLARE_DYNAMIC_CLASS(wxMenu)
 };
 
     DECLARE_DYNAMIC_CLASS(wxMenu)
 };
 


@@ -159,6 +143,7 @@ class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
 public:
     // ctors and dtor
     wxMenuBar(long WXUNUSED(style) = 0) { Init(); }
 public:
     // ctors and dtor
     wxMenuBar(long WXUNUSED(style) = 0) { Init(); }

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

     virtual ~wxMenuBar();
 
     // implement base class virtuals
     virtual ~wxMenuBar();
 
     // implement base class virtuals


@@ -179,8 +164,8 @@ public:
     // get the next item for the givan accel letter (used by wxFrame), return
     // -1 if none
     //
     // get the next item for the givan accel letter (used by wxFrame), return
     // -1 if none
     //

-    // if unique is not NULL, filled with TRUE if there is only one item with
-    // this accel, FALSE if two or more
+    // if unique is not NULL, filled with true if there is only one item with
+    // this accel, false if two or more

     int FindNextItemForAccel(int idxStart,
                              int keycode,
                              bool *unique = NULL) const;
     int FindNextItemForAccel(int idxStart,
                              int keycode,
                              bool *unique = NULL) const;


@@ -195,7 +180,7 @@ public:
 #endif // wxUSE_ACCEL
 
     // called by wxMenu when it is dismissed
 #endif // wxUSE_ACCEL
 
     // called by wxMenu when it is dismissed

-    void OnDismissMenu(bool dismissMenuBar = FALSE);
+    void OnDismissMenu(bool dismissMenuBar = false);

 
 protected:
     // common part of all ctors
 
 protected:
     // common part of all ctors


@@ -207,7 +192,7 @@ protected:
     void OnKeyDown(wxKeyEvent& event);
     void OnKillFocus(wxFocusEvent& event);
 
     void OnKeyDown(wxKeyEvent& event);
     void OnKillFocus(wxFocusEvent& event);
 

-    // process the mouse move event, return TRUE if we did, FALSE to continue
+    // process the mouse move event, return true if we did, false to continue

     // processing as usual
     //
     // the coordinates are client coordinates of menubar, convert if necessary
     // processing as usual
     //
     // the coordinates are client coordinates of menubar, convert if necessary


@@ -248,7 +233,7 @@ protected:
     void DoSelectMenu(size_t pos);
 
     // popup the currently selected menu
     void DoSelectMenu(size_t pos);
 
     // popup the currently selected menu

-    void PopupCurrentMenu(bool selectFirst = TRUE);
+    void PopupCurrentMenu(bool selectFirst = true);

 
     // hide the currently selected menu
     void DismissMenu();
 
     // hide the currently selected menu
     void DismissMenu();


@@ -259,6 +244,9 @@ protected:
     // we don't want to have focus except while selecting from menu
     void GiveAwayFocus();
 
     // we don't want to have focus except while selecting from menu
     void GiveAwayFocus();
 

+    // Release the mouse capture if we have it
+    bool ReleaseMouseCapture();
+

     // the array containing extra menu info we need
     wxMenuInfoArray m_menuInfos;
 
     // the array containing extra menu info we need
     wxMenuInfoArray m_menuInfos;