include/wx/slider.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/slider.h
   3 // Purpose:     wxSlider interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     09.02.01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1996-2001 wxWidgets team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SLIDER_H_BASE_
  13 #define _WX_SLIDER_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_SLIDER
  22
  23 #include "wx/control.h"
  24
  25 WXDLLEXPORT_DATA(extern const wxChar*) wxSliderNameStr;
  26
  27 // ----------------------------------------------------------------------------
  28 // wxSliderBase: define wxSlider interface
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxSliderBase : public wxControl
  32 {
  33 public:
  34     /* the ctor of the derived class should have the following form:
  35
  36     wxSlider(wxWindow *parent,
  37              wxWindowID id,
  38              int value, int minValue, int maxValue,
  39              const wxPoint& pos = wxDefaultPosition,
  40              const wxSize& size = wxDefaultSize,
  41              long style = wxSL_HORIZONTAL,
  42              const wxValidator& validator = wxDefaultValidator,
  43              const wxString& name = wxSliderNameStr);
  44     */
  45     wxSliderBase() { }
  46
  47     // get/set the current slider value (should be in range)
  48     virtual int GetValue() const = 0;
  49     virtual void SetValue(int value) = 0;
  50
  51     // retrieve/change the range
  52     virtual void SetRange(int minValue, int maxValue) = 0;
  53     virtual int GetMin() const = 0;
  54     virtual int GetMax() const = 0;
  55     void SetMin( int minValue ) { SetRange( minValue , GetMax() ) ; }
  56     void SetMax( int maxValue ) { SetRange( GetMin() , maxValue ) ; }
  57
  58     // the line/page size is the increment by which the slider moves when
  59     // cursor arrow key/page up or down are pressed (clicking the mouse is like
  60     // pressing PageUp/Down) and are by default set to 1 and 1/10 of the range
  61     virtual void SetLineSize(int lineSize) = 0;
  62     virtual void SetPageSize(int pageSize) = 0;
  63     virtual int GetLineSize() const = 0;
  64     virtual int GetPageSize() const = 0;
  65
  66     // these methods get/set the length of the slider pointer in pixels
  67     virtual void SetThumbLength(int lenPixels) = 0;
  68     virtual int GetThumbLength() const = 0;
  69
  70     // warning: most of subsequent methods are currently only implemented in
  71     //          wxMSW under Win95 and are silently ignored on other platforms
  72
  73     virtual void SetTickFreq(int WXUNUSED(n), int WXUNUSED(pos)) { }
  74     virtual int GetTickFreq() const { return 0; }
  75     virtual void ClearTicks() { }
  76     virtual void SetTick(int WXUNUSED(tickPos)) { }
  77
  78     virtual void ClearSel() { }
  79     virtual int GetSelEnd() const { return GetMin(); }
  80     virtual int GetSelStart() const { return GetMax(); }
  81     virtual void SetSelection(int WXUNUSED(min), int WXUNUSED(max)) { }
  82
  83
  84     virtual void ApplyParentThemeBackground(const wxColour& bg)
  85         { SetBackgroundColour(bg); }
  86
  87
  88 private:
  89     DECLARE_NO_COPY_CLASS(wxSliderBase)
  90 };
  91
  92 // ----------------------------------------------------------------------------
  93 // include the real class declaration
  94 // ----------------------------------------------------------------------------
  95
  96 #if defined(__WXUNIVERSAL__)
  97     #include "wx/univ/slider.h"
  98 #elif defined(__WXMSW__)
  99     #include "wx/msw/slider95.h"
 100     #define wxSlider wxSlider95
 101 #elif defined(__WXMOTIF__)
 102     #include "wx/motif/slider.h"
 103 #elif defined(__WXGTK__)
 104     #include "wx/gtk/slider.h"
 105 #elif defined(__WXMAC__)
 106     #include "wx/mac/slider.h"
 107 #elif defined(__WXCOCOA__)
 108     #include "wx/cocoa/slider.h"
 109 #elif defined(__WXPM__)
 110     #include "wx/os2/slider.h"
 111 #endif
 112
 113 #endif // wxUSE_SLIDER
 114
 115 #endif
 116     // _WX_SLIDER_H_BASE_