Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/radiobox.h b/include/wx/gtk1/radiobox.h
index 443ea706ecb10da4618e91d32cc78f6673b7af1f..8bbd9323937f43a7cd7226691f2a43417743337f 100644 (file)
--- a/include/wx/gtk1/radiobox.h
+++ b/include/wx/gtk1/radiobox.h
@@ -1,94 +1,136 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_RADIOBOX_H_
+#define _WX_GTK_RADIOBOX_H_

 
 

-#ifndef __GTKRADIOBOXH__
-#define __GTKRADIOBOXH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"

 #include "wx/bitmap.h"
 
 #include "wx/bitmap.h"
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxRadioBox;
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxRadioBoxNameStr;
-

 //-----------------------------------------------------------------------------
 // wxRadioBox
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxRadioBox
 //-----------------------------------------------------------------------------
 

-class wxRadioBox: public wxControl
+class WXDLLIMPEXP_CORE wxRadioBox : public wxControl,
+                                    public wxRadioBoxBase

 {
 {

+public:
+    // ctors and dtor
+    wxRadioBox() { Init(); }
+    wxRadioBox(wxWindow *parent,
+               wxWindowID id,
+               const wxString& title,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               int n = 0,
+               const wxString choices[] = (const wxString *) NULL,
+               int majorDim = 1,
+               long style = wxRA_SPECIFY_COLS,
+               const wxValidator& val = wxDefaultValidator,
+               const wxString& name = wxRadioBoxNameStr)
+    {
+        Init();
+
+        Create( parent, id, title, pos, size, n, choices, majorDim, style, val, name );
+    }

 
 

-  DECLARE_DYNAMIC_CLASS(wxRadioBox)
-  
-  public:
-  
-    wxRadioBox(void);
-    inline wxRadioBox( wxWindow *parent, wxWindowID id, const wxString& title,
-             const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
-             int n = 0, const wxString choices[] = (const wxString *) NULL,
-             int majorDim = 0, long style = wxRA_HORIZONTAL,
-             const wxValidator& val = wxDefaultValidator, 
-            const wxString& name = wxRadioBoxNameStr )
+    wxRadioBox(wxWindow *parent,
+               wxWindowID id,
+               const wxString& title,
+               const wxPoint& pos,
+               const wxSize& size,
+               const wxArrayString& choices,
+               int majorDim = 1,
+               long style = wxRA_SPECIFY_COLS,
+               const wxValidator& val = wxDefaultValidator,
+               const wxString& name = wxRadioBoxNameStr)

     {
     {

-      Create( parent, id, title, pos, size, n, choices, majorDim, style, val, name );
+        Init();
+
+        Create( parent, id, title, pos, size, choices, majorDim, style, val, name );

     }
     }

-    bool Create( wxWindow *parent, wxWindowID id, const wxString& title,
-             const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
-             int n = 0, const wxString choices[] = (const wxString *) NULL,
-             int majorDim = 0, long style = wxRA_HORIZONTAL,
-             const wxValidator& val = wxDefaultValidator, 
-            const wxString& name = wxRadioBoxNameStr );
-    int FindString( const wxString& s) const;
-    void SetSelection( int n );
-    int GetSelection(void) const;
-    wxString GetString( int n ) const;
-    wxString GetLabel(void) const;
-    void SetLabel( const wxString& label );
-    void SetLabel( int item, const wxString& label );
-    void SetLabel( int item, wxBitmap *bitmap );
-    wxString GetLabel( int item ) const;
-    bool Show( bool show );
-    void Enable( bool enable );
-    void Enable( int item, bool enable );
-    void Show( int item, bool show );
-    virtual wxString GetStringSelection(void) const;
-    virtual bool SetStringSelection( const wxString& s );
-    virtual int Number(void) const;
-    int GetNumberOfRowsOrCols(void) const;
-    void SetNumberOfRowsOrCols( int n );
-    void SetFont( const wxFont &font );
-
-  // implementation    
-    
-    bool            m_alreadySent;
-    
-  private:
-  
-    GtkRadioButton *m_radio;
-    
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                int n = 0,
+                const wxString choices[] = (const wxString *) NULL,
+                int majorDim = 0,
+                long style = wxRA_SPECIFY_COLS,
+                const wxValidator& val = wxDefaultValidator,
+                const wxString& name = wxRadioBoxNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                int majorDim = 0,
+                long style = wxRA_SPECIFY_COLS,
+                const wxValidator& val = wxDefaultValidator,
+                const wxString& name = wxRadioBoxNameStr);
+
+    virtual ~wxRadioBox();
+
+
+    // implement wxItemContainerImmutable methods
+    virtual unsigned int GetCount() const;
+
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& s);
+
+    virtual void SetSelection(int n);
+    virtual int GetSelection() const;
+
+
+    // implement wxRadioBoxBase methods
+    virtual bool Show(unsigned int n, bool show = true);
+    virtual bool Enable(unsigned int n, bool enable = true);
+
+    virtual bool IsItemEnabled(unsigned int n) const;
+    virtual bool IsItemShown(unsigned int n) const;
+
+
+    // override some base class methods to operate on radiobox itself too
+    virtual bool Show( bool show = true );
+    virtual bool Enable( bool enable = true );
+
+    virtual void SetLabel( const wxString& label );
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    // implementation
+    // --------------
+
+    void SetFocus();
+    void GtkDisableEvents();
+    void GtkEnableEvents();
+    bool IsOwnGtkWindow( GdkWindow *window );
+    void DoApplyWidgetStyle(GtkRcStyle *style);
+#if wxUSE_TOOLTIPS
+    void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
+#endif // wxUSE_TOOLTIPS
+
+    virtual void OnInternalIdle();
+
+    bool             m_hasFocus,
+                     m_lostFocus;
+    wxList           m_boxes;
+
+protected:
+    // common part of all ctors
+    void Init();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxRadioBox)

 };
 
 };
 

-#endif // __GTKRADIOBOXH__
+#endif // _WX_GTK_RADIOBOX_H_