src/msw/gauge.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/gauge95.cpp
   3 // Purpose:     wxGauge class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_GAUGE
  28
  29 #include "wx/gauge.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/app.h"
  33
  34     #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
  35 #endif
  36
  37 #include "wx/msw/private.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // constants
  41 // ----------------------------------------------------------------------------
  42
  43 // old commctrl.h (< 4.71) don't have those
  44 #ifndef PBS_SMOOTH
  45     #define PBS_SMOOTH 0x01
  46 #endif
  47
  48 #ifndef PBS_VERTICAL
  49     #define PBS_VERTICAL 0x04
  50 #endif
  51
  52 #ifndef PBM_SETBARCOLOR
  53     #define PBM_SETBARCOLOR         (WM_USER+9)
  54 #endif
  55
  56 #ifndef PBM_SETBKCOLOR
  57     #define PBM_SETBKCOLOR          0x2001
  58 #endif
  59
  60 #ifndef PBS_MARQUEE
  61     #define PBS_MARQUEE             0x08
  62 #endif
  63
  64 #ifndef PBM_SETMARQUEE
  65     #define PBM_SETMARQUEE          (WM_USER+10)
  66 #endif
  67
  68 // ----------------------------------------------------------------------------
  69 // wxWin macros
  70 // ----------------------------------------------------------------------------
  71
  72 #if wxUSE_EXTENDED_RTTI
  73 WX_DEFINE_FLAGS( wxGaugeStyle )
  74
  75 wxBEGIN_FLAGS( wxGaugeStyle )
  76     // new style border flags, we put them first to
  77     // use them for streaming out
  78     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  79     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  80     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  81     wxFLAGS_MEMBER(wxBORDER_RAISED)
  82     wxFLAGS_MEMBER(wxBORDER_STATIC)
  83     wxFLAGS_MEMBER(wxBORDER_NONE)
  84
  85     // old style border flags
  86     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  87     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  88     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  89     wxFLAGS_MEMBER(wxRAISED_BORDER)
  90     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  91     wxFLAGS_MEMBER(wxBORDER)
  92
  93     // standard window styles
  94     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  95     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  96     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  97     wxFLAGS_MEMBER(wxWANTS_CHARS)
  98     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  99     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
 100     wxFLAGS_MEMBER(wxVSCROLL)
 101     wxFLAGS_MEMBER(wxHSCROLL)
 102
 103     wxFLAGS_MEMBER(wxGA_HORIZONTAL)
 104     wxFLAGS_MEMBER(wxGA_VERTICAL)
 105 #if WXWIN_COMPATIBILITY_2_6
 106     wxFLAGS_MEMBER(wxGA_PROGRESSBAR)
 107 #endif // WXWIN_COMPATIBILITY_2_6
 108     wxFLAGS_MEMBER(wxGA_SMOOTH)
 109
 110 wxEND_FLAGS( wxGaugeStyle )
 111
 112 IMPLEMENT_DYNAMIC_CLASS_XTI(wxGauge, wxControl,"wx/gauge.h")
 113
 114 wxBEGIN_PROPERTIES_TABLE(wxGauge)
 115     wxPROPERTY( Value , int , SetValue, GetValue, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 116     wxPROPERTY( Range , int , SetRange, GetRange, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 117     wxPROPERTY( ShadowWidth , int , SetShadowWidth, GetShadowWidth, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 118     wxPROPERTY( BezelFace , int , SetBezelFace, GetBezelFace, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 119     wxPROPERTY_FLAGS( WindowStyle , wxGaugeStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 120 wxEND_PROPERTIES_TABLE()
 121
 122 wxBEGIN_HANDLERS_TABLE(wxGauge)
 123 wxEND_HANDLERS_TABLE()
 124
 125 wxCONSTRUCTOR_6( wxGauge , wxWindow* , Parent , wxWindowID , Id , int , Range , wxPoint , Position , wxSize , Size , long , WindowStyle )
 126 #else
 127 IMPLEMENT_DYNAMIC_CLASS(wxGauge, wxControl)
 128 #endif
 129
 130 // ============================================================================
 131 // wxGauge implementation
 132 // ============================================================================
 133
 134 // ----------------------------------------------------------------------------
 135 // wxGauge creation
 136 // ----------------------------------------------------------------------------
 137
 138 bool wxGauge::Create(wxWindow *parent,
 139                      wxWindowID id,
 140                      int range,
 141                      const wxPoint& pos,
 142                      const wxSize& size,
 143                      long style,
 144                      const wxValidator& validator,
 145                      const wxString& name)
 146 {
 147     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
 148         return false;
 149
 150     if ( !MSWCreateControl(PROGRESS_CLASS, wxEmptyString, pos, size) )
 151         return false;
 152
 153     SetRange(range);
 154
 155     // in case we need to emulate indeterminate mode...
 156     m_nDirection = wxRIGHT;
 157
 158     return true;
 159 }
 160
 161 WXDWORD wxGauge::MSWGetStyle(long style, WXDWORD *exstyle) const
 162 {
 163     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 164
 165     if ( style & wxGA_VERTICAL )
 166         msStyle |= PBS_VERTICAL;
 167
 168     if ( style & wxGA_SMOOTH )
 169         msStyle |= PBS_SMOOTH;
 170
 171     return msStyle;
 172 }
 173
 174 // ----------------------------------------------------------------------------
 175 // wxGauge geometry
 176 // ----------------------------------------------------------------------------
 177
 178 wxSize wxGauge::DoGetBestSize() const
 179 {
 180     // Windows HIG (http://msdn.microsoft.com/en-us/library/aa511279.aspx)
 181     // suggest progress bar size of "107 or 237 x 8 dialog units". Let's use
 182     // the smaller one.
 183
 184     if (HasFlag(wxGA_VERTICAL))
 185         return ConvertDialogToPixels(wxSize(8, 107));
 186     else
 187         return ConvertDialogToPixels(wxSize(107, 8));
 188 }
 189
 190 // ----------------------------------------------------------------------------
 191 // wxGauge setters
 192 // ----------------------------------------------------------------------------
 193
 194 void wxGauge::SetRange(int r)
 195 {
 196     // Changing range implicitly means we're using determinate mode.
 197     if ( IsInIndeterminateMode() )
 198         SetDeterminateMode();
 199
 200     m_rangeMax = r;
 201
 202 #ifdef PBM_SETRANGE32
 203     ::SendMessage(GetHwnd(), PBM_SETRANGE32, 0, r);
 204 #else // !PBM_SETRANGE32
 205     // fall back to PBM_SETRANGE (limited to 16 bits)
 206     ::SendMessage(GetHwnd(), PBM_SETRANGE, 0, MAKELPARAM(0, r));
 207 #endif // PBM_SETRANGE32/!PBM_SETRANGE32
 208 }
 209
 210 void wxGauge::SetValue(int pos)
 211 {
 212     // Setting the value implicitly means that we're using determinate mode.
 213     if ( IsInIndeterminateMode() )
 214         SetDeterminateMode();
 215
 216     if ( GetValue() != pos )
 217     {
 218         m_gaugePos = pos;
 219
 220         ::SendMessage(GetHwnd(), PBM_SETPOS, pos, 0);
 221     }
 222 }
 223
 224 bool wxGauge::SetForegroundColour(const wxColour& col)
 225 {
 226     if ( !wxControl::SetForegroundColour(col) )
 227         return false;
 228
 229     ::SendMessage(GetHwnd(), PBM_SETBARCOLOR, 0, (LPARAM)wxColourToRGB(col));
 230
 231     return true;
 232 }
 233
 234 bool wxGauge::SetBackgroundColour(const wxColour& col)
 235 {
 236     if ( !wxControl::SetBackgroundColour(col) )
 237         return false;
 238
 239     ::SendMessage(GetHwnd(), PBM_SETBKCOLOR, 0, (LPARAM)wxColourToRGB(col));
 240
 241     return true;
 242 }
 243
 244 bool wxGauge::IsInIndeterminateMode() const
 245 {
 246     return (::GetWindowLong(GetHwnd(), GWL_STYLE) & PBS_MARQUEE) != 0;
 247 }
 248
 249 void wxGauge::SetIndeterminateMode()
 250 {
 251     // Switch the control into indeterminate mode if necessary.
 252     if ( !IsInIndeterminateMode() )
 253     {
 254         const long style = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 255         ::SetWindowLong(GetHwnd(), GWL_STYLE, style | PBS_MARQUEE);
 256         ::SendMessage(GetHwnd(), PBM_SETMARQUEE, TRUE, 0);
 257     }
 258 }
 259
 260 void wxGauge::SetDeterminateMode()
 261 {
 262     if ( IsInIndeterminateMode() )
 263     {
 264         const long style = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 265         ::SendMessage(GetHwnd(), PBM_SETMARQUEE, FALSE, 0);
 266         ::SetWindowLong(GetHwnd(), GWL_STYLE, style & ~PBS_MARQUEE);
 267     }
 268 }
 269
 270 void wxGauge::Pulse()
 271 {
 272     if (wxApp::GetComCtl32Version() >= 600)
 273     {
 274         // switch to indeterminate mode if required
 275         SetIndeterminateMode();
 276
 277         SendMessage(GetHwnd(), PBM_STEPIT, 0, 0);
 278     }
 279     else
 280     {
 281         // emulate indeterminate mode
 282         wxGaugeBase::Pulse();
 283     }
 284 }
 285
 286 #endif // wxUSE_GAUGE