/////////////////////////////////////////////////////////////////////////////
-// Name: msw/spinctrl.cpp
+// Name: src/msw/spinctrl.cpp
// Purpose: wxSpinCtrl class implementation for Win32
// Author: Vadim Zeitlin
// Modified by:
// Created: 22.07.99
// RCS-ID: $Id$
-// Copyright: (c) Vadim Zeitlin
+// Copyright: (c) 1999-2005 Vadim Zeitlin
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// declarations
// ============================================================================
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "spinctrlbase.h"
- #pragma implementation "spinctrl.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#pragma hdrstop
#endif
-#ifndef WX_PRECOMP
- #include "wx/wx.h"
-#endif
-
#if wxUSE_SPINCTRL
-#if defined(__WIN95__)
-
#include "wx/spinctrl.h"
-#include "wx/msw/private.h"
-#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
- #include <commctrl.h>
+#ifndef WX_PRECOMP
+ #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+ #include "wx/event.h"
+ #include "wx/textctrl.h"
+ #include "wx/wxcrtvararg.h"
#endif
+#include "wx/msw/private.h"
+
+#if wxUSE_TOOLTIPS
+ #include "wx/tooltip.h"
+#endif // wxUSE_TOOLTIPS
+
#include <limits.h> // for INT_MIN
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxSpinCtrlStyle )
+
+wxBEGIN_FLAGS( wxSpinCtrlStyle )
+ // new style border flags, we put them first to
+ // use them for streaming out
+ wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+ wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+ wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+ wxFLAGS_MEMBER(wxBORDER_RAISED)
+ wxFLAGS_MEMBER(wxBORDER_STATIC)
+ wxFLAGS_MEMBER(wxBORDER_NONE)
+
+ // old style border flags
+ wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+ wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+ wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+ wxFLAGS_MEMBER(wxRAISED_BORDER)
+ wxFLAGS_MEMBER(wxSTATIC_BORDER)
+ wxFLAGS_MEMBER(wxBORDER)
+
+ // standard window styles
+ wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+ wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+ wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+ wxFLAGS_MEMBER(wxWANTS_CHARS)
+ wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+ wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+ wxFLAGS_MEMBER(wxVSCROLL)
+ wxFLAGS_MEMBER(wxHSCROLL)
+
+ wxFLAGS_MEMBER(wxSP_HORIZONTAL)
+ wxFLAGS_MEMBER(wxSP_VERTICAL)
+ wxFLAGS_MEMBER(wxSP_ARROW_KEYS)
+ wxFLAGS_MEMBER(wxSP_WRAP)
+
+wxEND_FLAGS( wxSpinCtrlStyle )
+
IMPLEMENT_DYNAMIC_CLASS_XTI(wxSpinCtrl, wxControl,"wx/spinbut.h")
-WX_BEGIN_PROPERTIES_TABLE(wxSpinCtrl)
- WX_PROPERTY( ValueString , wxString , SetValue , GetValue , ) ;
- WX_PROPERTY( Value , int , SetValue, GetValue, 0 )
- WX_PROPERTY( Min , int , SetMin, GetMin, 0 )
- WX_PROPERTY( Max , int , SetMax, GetMax, 0 )
+wxBEGIN_PROPERTIES_TABLE(wxSpinCtrl)
+ wxEVENT_RANGE_PROPERTY( Spin , wxEVT_SCROLL_TOP , wxEVT_SCROLL_CHANGED , wxSpinEvent )
+ wxEVENT_PROPERTY( Updated , wxEVT_COMMAND_SPINCTRL_UPDATED , wxCommandEvent )
+ wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
+ wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
+
+ wxPROPERTY( ValueString , wxString , SetValue , GetValue , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) ;
+ wxPROPERTY( Value , int , SetValue, GetValue, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY( Min , int , SetMin, GetMin, 0, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+ wxPROPERTY( Max , int , SetMax, GetMax, 0 , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY_FLAGS( WindowStyle , wxSpinCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
/*
- TODO PROPERTIES
- style wxSP_ARROW_KEYS
+ TODO PROPERTIES
+ style wxSP_ARROW_KEYS
*/
-WX_END_PROPERTIES_TABLE()
+wxEND_PROPERTIES_TABLE()
-WX_BEGIN_HANDLERS_TABLE(wxSpinCtrl)
-WX_END_HANDLERS_TABLE()
+wxBEGIN_HANDLERS_TABLE(wxSpinCtrl)
+wxEND_HANDLERS_TABLE()
-WX_CONSTRUCTOR_6( wxSpinCtrl , wxWindow* , Parent , wxWindowID , Id , wxString , ValueString , wxPoint , Position , wxSize , Size , long , WindowStyle )
+wxCONSTRUCTOR_6( wxSpinCtrl , wxWindow* , Parent , wxWindowID , Id , wxString , ValueString , wxPoint , Position , wxSize , Size , long , WindowStyle )
#else
IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxControl)
#endif
EVT_CHAR(wxSpinCtrl::OnChar)
EVT_SET_FOCUS(wxSpinCtrl::OnSetFocus)
-
- EVT_SPIN(-1, wxSpinCtrl::OnSpinChange)
+ EVT_KILL_FOCUS(wxSpinCtrl::OnKillFocus)
+ EVT_SPIN(wxID_ANY, wxSpinCtrl::OnSpinChange)
END_EVENT_TABLE()
#define GetBuddyHwnd() (HWND)(m_hwndBuddy)
WPARAM wParam,
LPARAM lParam)
{
- wxSpinCtrl *spin = (wxSpinCtrl *)::GetWindowLong(hwnd, GWL_USERDATA);
+ wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData(hwnd);
- // forward some messages (the key and focus ones only so far) to
- // the spin ctrl
+ // forward some messages (mostly the key and focus ones) to the spin ctrl
switch ( message )
{
case WM_SETFOCUS:
// if the focus comes from the spin control itself, don't set it
// back to it -- we don't want to go into an infinite loop
- if ( wParam == spin->GetHWND() )
+ if ( (WXHWND)wParam == spin->GetHWND() )
break;
//else: fall through
case WM_DEADCHAR:
case WM_KEYUP:
case WM_KEYDOWN:
+#ifdef WM_HELP
+ // we need to forward WM_HELP too to ensure that the context help
+ // associated with wxSpinCtrl is shown when the text control part of it
+ // is clicked with the "?" cursor
+ case WM_HELP:
+#endif
spin->MSWWindowProc(message, wParam, lParam);
// The control may have been deleted at this point, so check.
- if (!(::IsWindow(hwnd) && ((wxSpinCtrl *)::GetWindowLong(hwnd, GWL_USERDATA)) == spin))
+ if ( !::IsWindow(hwnd) || wxGetWindowUserData(hwnd) != spin )
return 0;
break;
/* static */
wxSpinCtrl *wxSpinCtrl::GetSpinForTextCtrl(WXHWND hwndBuddy)
{
- wxSpinCtrl *spin = (wxSpinCtrl *)::GetWindowLong((HWND)hwndBuddy,
- GWL_USERDATA);
+ wxSpinCtrl *spin = (wxSpinCtrl *)wxGetWindowUserData((HWND)hwndBuddy);
int i = ms_allSpins.Index(spin);
// process a WM_COMMAND generated by the buddy text control
bool wxSpinCtrl::ProcessTextCommand(WXWORD cmd, WXWORD WXUNUSED(id))
{
- switch (cmd)
+ if ( cmd == EN_CHANGE )
{
- case EN_CHANGE:
- {
- wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
- event.SetEventObject(this);
- wxString val = wxGetWindowText(m_hwndBuddy);
- event.SetString(val);
- event.SetInt(GetValue());
- return GetEventHandler()->ProcessEvent(event);
- }
- case EN_SETFOCUS:
- case EN_KILLFOCUS:
- {
- wxFocusEvent event(cmd == EN_KILLFOCUS ? wxEVT_KILL_FOCUS
- : wxEVT_SET_FOCUS,
- m_windowId);
- event.SetEventObject( this );
- return GetEventHandler()->ProcessEvent(event);
- }
- default:
- break;
+ wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
+ event.SetEventObject(this);
+ wxString val = wxGetWindowText(m_hwndBuddy);
+ event.SetString(val);
+ event.SetInt(GetValue());
+ return HandleWindowEvent(event);
}
// not processed
- return FALSE;
+ return false;
}
void wxSpinCtrl::OnChar(wxKeyEvent& event)
wxString val = wxGetWindowText(m_hwndBuddy);
event.SetString(val);
event.SetInt(GetValue());
- if ( GetEventHandler()->ProcessEvent(event) )
+ if ( HandleWindowEvent(event) )
return;
break;
}
eventNav.SetWindowChange(event.ControlDown());
eventNav.SetEventObject(this);
- if ( GetParent()->GetEventHandler()->ProcessEvent(eventNav) )
+ if ( GetParent()->HandleWindowEvent(eventNav) )
return;
}
break;
event.Skip();
}
+void wxSpinCtrl::OnKillFocus(wxFocusEvent& event)
+{
+ // ensure that a correct value is shown by the control
+ NormalizeValue();
+ event.Skip();
+}
+
void wxSpinCtrl::OnSetFocus(wxFocusEvent& event)
{
// when we get focus, give it to our buddy window as it needs it more than
event.Skip();
}
+void wxSpinCtrl::NormalizeValue()
+{
+ const int value = GetValue();
+ const bool changed = value != m_oldValue;
+
+ // notice that we have to call SetValue() even if the value didn't change
+ // because otherwise we could be left with empty buddy control when value
+ // is 0, see comment in SetValue()
+ SetValue(value);
+
+ if ( changed )
+ {
+ SendSpinUpdate(value);
+ }
+}
+
// ----------------------------------------------------------------------------
// construction
// ----------------------------------------------------------------------------
int min, int max, int initial,
const wxString& name)
{
+ // this should be in ctor/init function but I don't want to add one to 2.8
+ // to avoid problems with default ctor which can be inlined in the user
+ // code and so might not get this fix without recompilation
+ m_oldValue = INT_MIN;
+
// before using DoGetBestSize(), have to set style to let the base class
// know whether this is a horizontal or vertical control (we're always
// vertical)
style |= wxSP_VERTICAL;
if ( (style & wxBORDER_MASK) == wxBORDER_DEFAULT )
+#ifdef __WXWINCE__
+ style |= wxBORDER_SIMPLE;
+#else
style |= wxBORDER_SUNKEN;
+#endif
SetWindowStyle(style);
WXDWORD exStyle = 0;
WXDWORD msStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
- // calculate the sizes: the size given is the toal size for both controls
+ // this control is used for numeric entry so normally using these flags by
+ // default shouldn't be a problem, if it is we can always add a style such
+ // as wxSP_NON_NUMERIC later
+ msStyle |= ES_RIGHT | ES_NUMBER;
+
+ // calculate the sizes: the size given is the total size for both controls
// and we need to fit them both in the given width (height is the same)
wxSize sizeText(size), sizeBtn(size);
sizeBtn.x = wxSpinButton::DoGetBestSize().x;
{
wxLogLastError(wxT("CreateWindow(buddy text window)"));
- return FALSE;
+ return false;
}
// create the spin button
if ( !wxSpinButton::Create(parent, id, posBtn, sizeBtn, style, name) )
{
- return FALSE;
+ return false;
}
- SetRange(min, max);
- SetValue(initial);
+ wxSpinButtonBase::SetRange(min, max);
// subclass the text ctrl to be able to intercept some events
- m_wndProcBuddy = (WXFARPROC)::GetWindowLong(GetBuddyHwnd(), GWL_WNDPROC);
- ::SetWindowLong(GetBuddyHwnd(), GWL_USERDATA, (LONG)this);
- ::SetWindowLong(GetBuddyHwnd(), GWL_WNDPROC, (LONG)wxBuddyTextWndProc);
+ wxSetWindowUserData(GetBuddyHwnd(), this);
+ m_wndProcBuddy = (WXFARPROC)wxSetWindowProc(GetBuddyHwnd(),
+ wxBuddyTextWndProc);
- // should have the same font as the other controls
- SetFont(GetParent()->GetFont());
+ // set up fonts and colours (This is nomally done in MSWCreateControl)
+ InheritAttributes();
+ if (!m_hasFont)
+ SetFont(GetDefaultAttributes().font);
// set the size of the text window - can do it only now, because we
// couldn't call DoGetBestSize() before as font wasn't set
if ( sizeText.y <= 0 )
{
int cx, cy;
- wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
+ wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
sizeText.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy);
}
- DoMoveWindow(pos.x, pos.y,
- sizeText.x + sizeBtn.x + MARGIN_BETWEEN, sizeText.y);
+ SetInitialSize(size);
(void)::ShowWindow(GetBuddyHwnd(), SW_SHOW);
// associate the text window with the spin button
(void)::SendMessage(GetHwnd(), UDM_SETBUDDY, (WPARAM)m_hwndBuddy, 0);
- if ( !value.IsEmpty() )
+ SetValue(initial);
+
+ // Set the range in the native control
+ SetRange(min, max);
+
+ if ( !value.empty() )
{
SetValue(value);
+ m_oldValue = (int) wxAtol(value);
+ }
+ else
+ {
+ SetValue(wxString::Format(wxT("%d"), initial));
+ m_oldValue = initial;
}
// do it after finishing with m_hwndBuddy creation to avoid generating
// initial wxEVT_COMMAND_TEXT_UPDATED message
ms_allSpins.Add(this);
- return TRUE;
+ return true;
}
wxSpinCtrl::~wxSpinCtrl()
}
}
+void wxSpinCtrl::SetValue(int val)
+{
+ wxSpinButton::SetValue(val);
+
+ // normally setting the value of the spin button is enough as it updates
+ // its buddy control automatically ...
+ if ( wxGetWindowText(m_hwndBuddy).empty() )
+ {
+ // ... but sometimes it doesn't, notably when the value is 0 and the
+ // text control is currently empty, the spin button seems to be happy
+ // to leave it like this, while we really want to always show the
+ // current value in the control, so do it manually
+ ::SetWindowText(GetBuddyHwnd(),
+ wxString::Format(_T("%d"), val).wx_str());
+ }
+
+ m_oldValue = GetValue();
+}
+
int wxSpinCtrl::GetValue() const
{
wxString val = wxGetWindowText(m_hwndBuddy);
long n;
- if ( (wxSscanf(val, wxT("%lu"), &n) != 1) )
+ if ( (wxSscanf(val, wxT("%ld"), &n) != 1) )
n = INT_MIN;
+ if ( n < m_min )
+ n = m_min;
+ if ( n > m_max )
+ n = m_max;
+
return n;
}
void wxSpinCtrl::SetSelection(long from, long to)
{
- // if from and to are both -1, it means (in wxWindows) that all text should
+ // if from and to are both -1, it means (in wxWidgets) that all text should
// be selected - translate into Windows convention
if ( (from == -1) && (to == -1) )
{
from = 0;
}
- ::SendMessage((HWND)m_hwndBuddy, EM_SETSEL, (WPARAM)from, (LPARAM)to);
+ ::SendMessage(GetBuddyHwnd(), EM_SETSEL, (WPARAM)from, (LPARAM)to);
}
// ----------------------------------------------------------------------------
if ( !wxWindowBase::SetFont(font) )
{
// nothing to do
- return FALSE;
+ return false;
}
WXHANDLE hFont = GetFont().GetResourceHandle();
(void)::SendMessage(GetBuddyHwnd(), WM_SETFONT, (WPARAM)hFont, TRUE);
- return TRUE;
+ return true;
}
bool wxSpinCtrl::Show(bool show)
{
if ( !wxControl::Show(show) )
{
- return FALSE;
+ return false;
}
::ShowWindow(GetBuddyHwnd(), show ? SW_SHOW : SW_HIDE);
- return TRUE;
+ return true;
}
bool wxSpinCtrl::Enable(bool enable)
{
if ( !wxControl::Enable(enable) )
{
- return FALSE;
+ return false;
}
::EnableWindow(GetBuddyHwnd(), enable);
- return TRUE;
+ return true;
}
void wxSpinCtrl::SetFocus()
::SetFocus(GetBuddyHwnd());
}
+#if wxUSE_TOOLTIPS
+
+void wxSpinCtrl::DoSetToolTip(wxToolTip *tip)
+{
+ wxSpinButton::DoSetToolTip(tip);
+
+ if ( tip )
+ tip->Add(m_hwndBuddy);
+}
+
+#endif // wxUSE_TOOLTIPS
+
// ----------------------------------------------------------------------------
-// event processing
+// events processing and generation
// ----------------------------------------------------------------------------
-void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
+void wxSpinCtrl::SendSpinUpdate(int value)
{
wxCommandEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
event.SetEventObject(this);
- event.SetInt(eventSpin.GetPosition());
+ event.SetInt(value);
+
+ (void)HandleWindowEvent(event);
- (void)GetEventHandler()->ProcessEvent(event);
+ m_oldValue = value;
+}
- if ( eventSpin.GetSkipped() )
+void wxSpinCtrl::OnSpinChange(wxSpinEvent& eventSpin)
+{
+ const int value = eventSpin.GetPosition();
+ if ( value != m_oldValue )
{
- event.Skip();
+ SendSpinUpdate(value);
}
}
sizeBtn.x += DEFAULT_ITEM_WIDTH + MARGIN_BETWEEN;
int y;
- wxGetCharSize(GetHWND(), NULL, &y, &GetFont());
+ wxGetCharSize(GetHWND(), NULL, &y, GetFont());
y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(y);
- if ( sizeBtn.y < y )
+ // JACS: we should always use the height calculated
+ // from above, because otherwise we'll get a spin control
+ // that's too big. So never use the height calculated
+ // from wxSpinButton::DoGetBestSize().
+
+ // if ( sizeBtn.y < y )
{
// make the text tall enough
sizeBtn.y = y;
wxLogDebug(_T("not enough space for wxSpinCtrl!"));
}
- if ( !::MoveWindow(GetBuddyHwnd(), x, y, widthText, height, TRUE) )
- {
- wxLogLastError(wxT("MoveWindow(buddy)"));
- }
+ // 1) The buddy window
+ DoMoveSibling(m_hwndBuddy, x, y, widthText, height);
+ // 2) The button window
x += widthText + MARGIN_BETWEEN;
- if ( !::MoveWindow(GetHwnd(), x, y, widthBtn, height, TRUE) )
- {
- wxLogLastError(wxT("MoveWindow"));
- }
+ wxSpinButton::DoMoveWindow(x, y, widthBtn, height);
}
// get total size of the control
*y = ctrlrect.bottom - ctrlrect.top;
}
+void wxSpinCtrl::DoGetClientSize(int *x, int *y) const
+{
+ RECT spinrect = wxGetClientRect(GetHwnd());
+ RECT textrect = wxGetClientRect(GetBuddyHwnd());
+ RECT ctrlrect;
+ UnionRect(&ctrlrect,&textrect, &spinrect);
+
+ if ( x )
+ *x = ctrlrect.right - ctrlrect.left;
+ if ( y )
+ *y = ctrlrect.bottom - ctrlrect.top;
+}
+
void wxSpinCtrl::DoGetPosition(int *x, int *y) const
{
// hack: pretend that our HWND is the text control just for a moment
wxConstCast(this, wxSpinCtrl)->m_hWnd = hWnd;
}
-#endif // __WIN95__
-
-#endif
- // wxUSE_SPINCTRL
-
+#endif // wxUSE_SPINCTRL