added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-03-08 13:52:38 +00:00
parent 5d713a7574
commit 23324ae1c7
272 changed files with 92200 additions and 9 deletions
--- a/interface/spinctrl.h
+++ b/interface/spinctrl.h
@@ -0,0 +1,136 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        spinctrl.h
+// Purpose:     documentation for wxSpinCtrl class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxSpinCtrl
+    @wxheader{spinctrl.h}
+    
+    wxSpinCtrl combines wxTextCtrl and 
+    wxSpinButton in one control.
+    
+    @beginStyleTable
+    @style{wxSP_ARROW_KEYS}:
+           The user can use arrow keys to change the value.
+    @style{wxSP_WRAP}:
+           The value wraps at the minimum and maximum.
+    @endStyleTable
+    
+    @library{wxcore}
+    @category{ctrl}
+    @appearance{spinctrl.png}
+    
+    @seealso
+    @ref overview_eventhandlingoverview "Event handling overview", wxSpinButton,
+    wxControl
+*/
+class wxSpinCtrl : public wxControl
+{
+public:
+    //@{
+    /**
+        )
+        
+        Constructor, creating and showing a spin control.
+        
+        @param parent 
+        Parent window. Must not be @NULL.
+        
+        @param value 
+        Default value.
+        
+        @param id 
+        Window identifier. The value wxID_ANY indicates a default value.
+        
+        @param pos 
+        Window position. If wxDefaultPosition is specified then a default position
+        is chosen.
+        
+        @param size 
+        Window size. If wxDefaultSize is specified then a default size is
+        chosen.
+        
+        @param style 
+        Window style. See wxSpinButton.
+        
+        @param min 
+        Minimal value.
+        
+        @param max 
+        Maximal value.
+        
+        @param initial 
+        Initial value.
+        
+        @param name 
+        Window name.
+        
+        @sa Create()
+    */
+    wxSpinCtrl();
+        wxSpinCtrl(wxWindow* parent, wxWindowID id = -1,
+                   const wxString& value = wxEmptyString,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   long style = wxSP_ARROW_KEYS,
+                   int min = 0, int max = 100,
+                   int initial = 0);
+    //@}
+
+    /**
+        )
+        
+        Creation function called by the spin control constructor.
+        
+        See wxSpinCtrl() for details.
+    */
+    bool Create(wxWindow* parent, wxWindowID id = -1,
+                const wxString& value = wxEmptyString,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxSP_ARROW_KEYS,
+                int min = 0, int max = 100,
+                int initial = 0);
+
+    /**
+        Gets maximal allowable value.
+    */
+    int GetMax();
+
+    /**
+        Gets minimal allowable value.
+    */
+    int GetMin();
+
+    /**
+        Gets the value of the spin control.
+    */
+    int GetValue();
+
+    /**
+        Sets range of allowable values.
+    */
+    void SetRange(int minVal, int maxVal);
+
+    /**
+        Select the text in the text part of the control between  positions 
+        @e from (inclusive) and @e to (exclusive). This is similar to 
+        wxTextCtrl::SetSelection.
+        
+        @b NB: this is currently only implemented for Windows and generic versions
+        of the control.
+    */
+    void SetSelection(long from, long to);
+
+    //@{
+    /**
+        Sets the value of the spin control.
+    */
+    void SetValue(const wxString& text);
+        void SetValue(int value);
+    //@}
+};