refactor wxStaticText::Ellipsize so it's a static public utility function; document...

[wxWidgets.git] / include / wx / slider.h

diff --git a/include/wx/slider.h b/include/wx/slider.h
index 2aa7485212af8887bfd14b56e9ae3cc915caebd9..7a92223486d1a6445204fa7159fdca37039c448b 100644 (file)
--- a/include/wx/slider.h
+++ b/include/wx/slider.h
@@ -1,13 +1,151 @@
-#ifndef __SLIDERH_BASE__
-#define __SLIDERH_BASE__
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/slider.h
+// Purpose:     wxSlider interface
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     09.02.01
+// RCS-ID:      $Id$
+// Copyright:   (c) 1996-2001 Vadim Zeitlin
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
 
-#if defined(__WXMSW__)
-#include "wx/msw/slider.h"
+#ifndef _WX_SLIDER_H_BASE_
+#define _WX_SLIDER_H_BASE_
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#include "wx/defs.h"
+
+#if wxUSE_SLIDER
+
+#include "wx/control.h"
+
+// ----------------------------------------------------------------------------
+// wxSlider flags
+// ----------------------------------------------------------------------------
+
+#define wxSL_HORIZONTAL      wxHORIZONTAL /* 0x0004 */
+#define wxSL_VERTICAL        wxVERTICAL   /* 0x0008 */
+
+#define wxSL_TICKS           0x0010
+#define wxSL_AUTOTICKS       wxSL_TICKS // we don't support manual ticks
+#define wxSL_LABELS          0x0020
+#define wxSL_LEFT            0x0040
+#define wxSL_TOP             0x0080
+#define wxSL_RIGHT           0x0100
+#define wxSL_BOTTOM          0x0200
+#define wxSL_BOTH            0x0400
+#define wxSL_SELRANGE        0x0800
+#define wxSL_INVERSE         0x1000
+
+#if WXWIN_COMPATIBILITY_2_6
+    // obsolete
+    #define wxSL_NOTIFY_DRAG     0x0000
+#endif // WXWIN_COMPATIBILITY_2_6
+
+extern WXDLLIMPEXP_DATA_CORE(const char) wxSliderNameStr[];
+
+// ----------------------------------------------------------------------------
+// wxSliderBase: define wxSlider interface
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxSliderBase : public wxControl
+{
+public:
+    /* the ctor of the derived class should have the following form:
+
+    wxSlider(wxWindow *parent,
+             wxWindowID id,
+             int value, int minValue, int maxValue,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = wxSL_HORIZONTAL,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = wxSliderNameStr);
+    */
+    wxSliderBase() { }
+
+    // get/set the current slider value (should be in range)
+    virtual int GetValue() const = 0;
+    virtual void SetValue(int value) = 0;
+
+    // retrieve/change the range
+    virtual void SetRange(int minValue, int maxValue) = 0;
+    virtual int GetMin() const = 0;
+    virtual int GetMax() const = 0;
+    void SetMin( int minValue ) { SetRange( minValue , GetMax() ) ; }
+    void SetMax( int maxValue ) { SetRange( GetMin() , maxValue ) ; }
+
+    // the line/page size is the increment by which the slider moves when
+    // cursor arrow key/page up or down are pressed (clicking the mouse is like
+    // pressing PageUp/Down) and are by default set to 1 and 1/10 of the range
+    virtual void SetLineSize(int lineSize) = 0;
+    virtual void SetPageSize(int pageSize) = 0;
+    virtual int GetLineSize() const = 0;
+    virtual int GetPageSize() const = 0;
+
+    // these methods get/set the length of the slider pointer in pixels
+    virtual void SetThumbLength(int lenPixels) = 0;
+    virtual int GetThumbLength() const = 0;
+
+    // warning: most of subsequent methods are currently only implemented in
+    //          wxMSW under Win95 and are silently ignored on other platforms
+
+    virtual void SetTickFreq(int WXUNUSED(n), int WXUNUSED(pos)) { }
+    virtual int GetTickFreq() const { return 0; }
+    virtual void ClearTicks() { }
+    virtual void SetTick(int WXUNUSED(tickPos)) { }
+
+    virtual void ClearSel() { }
+    virtual int GetSelEnd() const { return GetMin(); }
+    virtual int GetSelStart() const { return GetMax(); }
+    virtual void SetSelection(int WXUNUSED(min), int WXUNUSED(max)) { }
+
+protected:
+
+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
+
+    // adjust value according to wxSL_INVERSE style
+    virtual int ValueInvertOrNot(int value) const
+    {
+        if (HasFlag(wxSL_INVERSE))
+            return (GetMax() + GetMin()) - value;
+        else
+            return value;
+    }
+
+private:
+    DECLARE_NO_COPY_CLASS(wxSliderBase)
+};
+
+// ----------------------------------------------------------------------------
+// include the real class declaration
+// ----------------------------------------------------------------------------
+
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/slider.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/slider.h"
 #elif defined(__WXMOTIF__)
-#include "wx/xt/slider.h"
+    #include "wx/motif/slider.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/slider.h"
 #elif defined(__WXGTK__)
-#include "wx/gtk/slider.h"
+    #include "wx/gtk1/slider.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/slider.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/slider.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/slider.h"
+#elif defined(__WXPALMOS__)
+    #include "wx/palmos/slider.h"
 #endif
 
+#endif // wxUSE_SLIDER
+
 #endif
-    // __SLIDERH_BASE__
+    // _WX_SLIDER_H_BASE_