From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 6 May 2002 11:40:16 +0000 (+0000)
Subject: added wxCheckBox::IsChecked() to wxMac and documented it
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/6e8e9b6628556d1155ec1372d9a8b0d0dac64794

added wxCheckBox::IsChecked() to wxMac and documented it


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15396 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex
index 396a731764..f527c84907 100644
--- a/docs/latex/wx/checkbox.tex
+++ b/docs/latex/wx/checkbox.tex
@@ -93,7 +93,15 @@ Gets the state of the checkbox.
 
 \wxheading{Return value}
 
-Returns TRUE if it is checked, FALSE otherwise.
+Returns {\tt TRUE} if it is checked, {\tt FALSE} otherwise.
+
+\membersection{wxCheckBox::IsChecked}\label{wxcheckboxischecked}
+
+\constfunc{bool}{IsChecked}{\void}
+
+This is just a maybe more readable synonym for 
+\helpref{GetValue}{wxcheckboxgetvalue}: just as the latter, it returns 
+{\tt TRUE} if the checkbox is checked and {\tt FALSE} otherwise.
 
 \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue}
 
@@ -104,6 +112,6 @@ wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted.
 
 \wxheading{Parameters}
 
-\docparam{state}{If TRUE, the check is on, otherwise it is off.}
+\docparam{state}{If {\tt TRUE|, the check is on, otherwise it is off.}
 
 
diff --git a/include/wx/mac/checkbox.h b/include/wx/mac/checkbox.h
index c17a18a82d..3ca0a6f415 100644
--- a/include/wx/mac/checkbox.h
+++ b/include/wx/mac/checkbox.h
@@ -6,7 +6,7 @@
 // Created:     ??/??/98
 // RCS-ID:      $Id$
 // Copyright:   (c) AUTHOR
-// Licence:   	wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CHECKBOX_H_
@@ -16,69 +16,65 @@
 #pragma interface "checkbox.h"
 #endif
 
-#include "wx/control.h"
-
-WXDLLEXPORT_DATA(extern const char*) wxCheckBoxNameStr;
-
 // Checkbox item (single checkbox)
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxCheckBox: public wxControl
+class WXDLLEXPORT wxCheckBox : public wxCheckBoxBase
 {
-  DECLARE_DYNAMIC_CLASS(wxCheckBox)
+public:
+    wxCheckBox() { }
+    wxCheckBox(wxWindow *parent, wxWindowID id, const wxString& label,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize, long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxCheckBoxNameStr)
+    {
+        Create(parent, id, label, pos, size, style, validator, name);
+    }
 
- public:
-  inline wxCheckBox() { }
-  inline wxCheckBox(wxWindow *parent, wxWindowID id, const wxString& label,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize, long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxCheckBoxNameStr)
-  {
-      Create(parent, id, label, pos, size, style, validator, name);
-  }
+    bool Create(wxWindow *parent, wxWindowID id, const wxString& label,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize, long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxCheckBoxNameStr);
+    virtual void SetValue(bool);
+    virtual bool GetValue() const;
+    virtual void MacHandleControlClick( WXWidget control , wxInt16 controlpart );
+    virtual void Command(wxCommandEvent& event);
 
-  bool Create(wxWindow *parent, wxWindowID id, const wxString& label,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize, long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxCheckBoxNameStr);
-  virtual void SetValue(bool);
-  virtual bool GetValue() const ;
-	virtual void 						MacHandleControlClick( WXWidget control , wxInt16 controlpart ) ;
-  virtual void Command(wxCommandEvent& event);
+    DECLARE_DYNAMIC_CLASS(wxCheckBox)
 };
 
+class WXDLLEXPORT wxBitmap;
 class WXDLLEXPORT wxBitmapCheckBox: public wxCheckBox
 {
-    DECLARE_DYNAMIC_CLASS(wxBitmapCheckBox)
-
 public:
-    int checkWidth ;
-    int checkHeight ;
+    int checkWidth;
+    int checkHeight;
 
     wxBitmapCheckBox()
         : checkWidth(-1), checkHeight(-1)
         { }
-  
-  wxBitmapCheckBox(wxWindow *parent, wxWindowID id, const wxBitmap *label,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize, long style = 0,
-                   const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = wxCheckBoxNameStr)
-  {
-      Create(parent, id, label, pos, size, style, validator, name);
-  }
 
-  bool Create(wxWindow *parent, wxWindowID id, const wxBitmap *bitmap,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize, long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxCheckBoxNameStr);
-  virtual void SetValue(bool);
-  virtual bool GetValue() const ;
-  virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-  virtual void SetLabel(const wxBitmap *bitmap);
-  virtual void SetLabel( const wxString & WXUNUSED(name) ) {} 
+    wxBitmapCheckBox(wxWindow *parent, wxWindowID id, const wxBitmap *label,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize, long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxCheckBoxNameStr)
+    {
+        Create(parent, id, label, pos, size, style, validator, name);
+    }
+
+    bool Create(wxWindow *parent, wxWindowID id, const wxBitmap *bitmap,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize, long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxCheckBoxNameStr);
+    virtual void SetValue(bool);
+    virtual bool GetValue() const;
+    virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
+    virtual void SetLabel(const wxBitmap *bitmap);
+    virtual void SetLabel( const wxString & WXUNUSED(name) ) {}
+
+    DECLARE_DYNAMIC_CLASS(wxBitmapCheckBox)
 };
 #endif
     // _WX_CHECKBOX_H_