Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / gtk1 / menuitem.h

diff --git a/include/wx/gtk1/menuitem.h b/include/wx/gtk1/menuitem.h
index f20657838abab6bc143e60110ebb90c36f24531b..48b3778e365a038bcd85f44b26dbbcb15c6da9a6 100644 (file)
--- a/include/wx/gtk1/menuitem.h
+++ b/include/wx/gtk1/menuitem.h
@@ -1,90 +1,78 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        menuitem.h
+// Name:        wx/gtk1/menuitem.h

 // Purpose:     wxMenuItem class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Purpose:     wxMenuItem class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKMENUITEMH__
 #define __GTKMENUITEMH__
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKMENUITEMH__
 #define __GTKMENUITEMH__
 

-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/string.h"
-
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-#define   ID_SEPARATOR    (-1)
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxMenuItem;
-
-class wxMenu;
+#include "wx/bitmap.h"

 
 //-----------------------------------------------------------------------------
 // wxMenuItem
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxMenuItem
 //-----------------------------------------------------------------------------
 

-class wxMenuItem: public wxObject
+class WXDLLIMPEXP_CORE wxMenuItem : public wxMenuItemBase

 {
 {

-DECLARE_DYNAMIC_CLASS(wxMenuItem)
-

 public:
 public:

-  wxMenuItem();
-
-  // accessors
-    // id
-  void SetId(int id) { m_id = id; }
-  int  GetId() const { return m_id; }
-  bool IsSeparator() const { return m_id == ID_SEPARATOR; }
-
-    // the item's text
-  void SetText(const wxString& str);
-  const wxString& GetText() const { return m_text; }
-
-    // what kind of menu item we are
-  void SetCheckable(bool checkable) { m_isCheckMenu = checkable; }
-  bool IsCheckable() const { return m_isCheckMenu; }
-  void SetSubMenu(wxMenu *menu) { m_subMenu = menu; }
-  wxMenu *GetSubMenu() const { return m_subMenu; }
-  bool IsSubMenu() const { return m_subMenu != NULL; }
+    wxMenuItem(wxMenu *parentMenu = NULL,
+               int id = wxID_SEPARATOR,
+               const wxString& text = wxEmptyString,
+               const wxString& help = wxEmptyString,
+               wxItemKind kind = wxITEM_NORMAL,
+               wxMenu *subMenu = NULL);
+    virtual ~wxMenuItem();
+
+    // implement base class virtuals
+    virtual void SetItemLabel( const wxString& str );
+    virtual wxString GetItemLabel() const;
+    virtual void Enable( bool enable = TRUE );
+    virtual void Check( bool check = TRUE );
+    virtual bool IsChecked() const;
+    virtual void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
+    virtual const wxBitmap& GetBitmap() const { return m_bitmap; }
+
+#if wxUSE_ACCEL
+    virtual wxAcceleratorEntry *GetAccel() const;
+#endif // wxUSE_ACCEL
+
+    // implementation
+    void SetMenuItem(GtkWidget *menuItem) { m_menuItem = menuItem; }
+    GtkWidget *GetMenuItem() const { return m_menuItem; }
+    GtkWidget *GetLabelWidget() const { return m_labelWidget; }
+    void SetLabelWidget(GtkWidget *labelWidget) { m_labelWidget = labelWidget; }
+    wxString GetFactoryPath() const;
+
+    wxString GetHotKey() const { return m_hotKey; }
+
+    // compatibility only, don't use in new code
+    wxMenuItem(wxMenu *parentMenu,
+               int id,
+               const wxString& text,
+               const wxString& help,
+               bool isCheckable,
+               wxMenu *subMenu = NULL);

 
 

-    // state
-  void Enable( bool enable = TRUE ); 
-  bool IsEnabled() const { return m_isEnabled; }
-  void Check( bool check = TRUE );
-  bool IsChecked() const;
+private:
+    // common part of all ctors
+    void Init();

 
 

-    // help string (displayed in the status bar by default)
-  void SetHelp(const wxString& str) { m_helpStr = str; }
-  const wxString& GetHelp() const { return m_helpStr; }
+    // DoSetText() transforms the accel mnemonics in our label from MSW/wxWin
+    // style to GTK+ and is called from ctor and SetText()
+    void DoSetText(const wxString& text);

 
 

-  // implementation
-  void SetMenuItem(GtkWidget *menuItem) { m_menuItem = menuItem; }
-  GtkWidget *GetMenuItem() const { return m_menuItem; }
+    wxString  m_hotKey;
+    wxBitmap  m_bitmap; // Bitmap for menuitem, if any

 
 

-private:
-  int           m_id;
-  wxString      m_text;
-  bool          m_isCheckMenu;
-  bool          m_isChecked;
-  bool          m_isEnabled;
-  wxMenu       *m_subMenu;
-  wxString      m_helpStr;
+    GtkWidget *m_menuItem;  // GtkMenuItem
+    GtkWidget* m_labelWidget; // Label widget

 
 

-  GtkWidget    *m_menuItem;  // GtkMenuItem
+    DECLARE_DYNAMIC_CLASS(wxMenuItem)

 };
 
 };
 

-
-#endif  
+#endif

         //__GTKMENUITEMH__
         //__GTKMENUITEMH__