// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "button.h"
#endif
#pragma hdrstop
#endif
+#if wxUSE_BUTTON
+
#ifndef WX_PRECOMP
+ #include "wx/app.h"
#include "wx/button.h"
#include "wx/brush.h"
#include "wx/panel.h"
// macros
// ----------------------------------------------------------------------------
+#if wxUSE_EXTENDED_RTTI
+
+WX_DEFINE_FLAGS( wxButtonStyle )
+
+wxBEGIN_FLAGS( wxButtonStyle )
+ // 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(wxBU_LEFT)
+ wxFLAGS_MEMBER(wxBU_RIGHT)
+ wxFLAGS_MEMBER(wxBU_TOP)
+ wxFLAGS_MEMBER(wxBU_BOTTOM)
+ wxFLAGS_MEMBER(wxBU_EXACTFIT)
+wxEND_FLAGS( wxButtonStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxButton, wxControl,"wx/button.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxButton)
+ wxEVENT_PROPERTY( Click , wxEVT_COMMAND_BUTTON_CLICKED , wxCommandEvent)
+
+ wxPROPERTY( Font , wxFont , SetFont , GetFont , , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+ wxPROPERTY( Label, wxString , SetLabel, GetLabel, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+
+ wxPROPERTY_FLAGS( WindowStyle , wxButtonStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxButton)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_6( wxButton , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
+
+
+#else
IMPLEMENT_DYNAMIC_CLASS(wxButton, wxControl)
+#endif
// this macro tries to adjust the default button height to a reasonable value
// using the char height as the base
const wxValidator& validator,
const wxString& name)
{
- if ( !CreateBase(parent, id, pos, size, style, validator, name) )
+ if ( !CreateControl(parent, id, pos, size, style, validator, name) )
return FALSE;
- parent->AddChild((wxButton *)this);
-
- m_backgroundColour = parent->GetBackgroundColour();
- m_foregroundColour = parent->GetForegroundColour();
-
-
- m_hWnd = (WXHWND)CreateWindowEx
- (
- MakeExtendedStyle(m_windowStyle),
- wxT("BUTTON"),
- label,
- WS_VISIBLE | WS_TABSTOP | WS_CHILD,
- 0, 0, 0, 0,
- GetWinHwnd(parent),
- (HMENU)m_windowId,
- wxGetInstance(),
- NULL
- );
-
- // Subclass again for purposes of dialog editing mode
- SubclassWin(m_hWnd);
+ WXDWORD exstyle;
+ WXDWORD msStyle = MSWGetStyle(style, &exstyle);
- SetFont(parent->GetFont());
-
- SetSize(pos.x, pos.y, size.x, size.y);
-
- // bad hack added by Robert to make buttons at least
- // 80 pixels wide. There are probably better ways...
- // TODO. FIXME.
- wxSize nsize( GetSize() );
- if ((nsize.x < 80) || (nsize.y < 23))
+#ifdef __WIN32__
+ // if the label contains several lines we must explicitly tell the button
+ // about it or it wouldn't draw it correctly ("\n"s would just appear as
+ // black boxes)
+ //
+ // NB: we do it here and not in MSWGetStyle() because we need the label
+ // value and m_label is not set yet when MSWGetStyle() is called;
+ // besides changing BS_MULTILINE during run-time is pointless anyhow
+ if ( label.find(_T('\n')) != wxString::npos )
{
- if ((size.x == -1) && (nsize.x < 80))
- nsize.x = 80;
- if ((size.y == -1) && (nsize.y < 23))
- nsize.y = 23;
- SetSize( nsize );
+ msStyle |= BS_MULTILINE;
}
+#endif // __WIN32__
- return TRUE;
+ return MSWCreateControl(_T("BUTTON"), msStyle, pos, size, label, exstyle);
}
wxButton::~wxButton()
{
- wxPanel *panel = wxDynamicCast(GetParent(), wxPanel);
- if ( panel )
- {
- if ( panel->GetDefaultItem() == this )
- {
- // don't leave the panel with invalid default item
- panel->SetDefaultItem(NULL);
- }
- }
+}
+
+// ----------------------------------------------------------------------------
+// flags
+// ----------------------------------------------------------------------------
+
+WXDWORD wxButton::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+ // buttons never have an external border, they draw their own one
+ WXDWORD msStyle = wxControl::MSWGetStyle
+ (
+ (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
+ );
+
+ // we must use WS_CLIPSIBLINGS with the buttons or they would draw over
+ // each other in any resizeable dialog which has more than one button in
+ // the bottom
+ msStyle |= WS_CLIPSIBLINGS;
+
+#ifdef __WIN32__
+ // don't use "else if" here: weird as it is, but you may combine wxBU_LEFT
+ // and wxBU_RIGHT to get BS_CENTER!
+ if ( style & wxBU_LEFT )
+ msStyle |= BS_LEFT;
+ if ( style & wxBU_RIGHT )
+ msStyle |= BS_RIGHT;
+ if ( style & wxBU_TOP )
+ msStyle |= BS_TOP;
+ if ( style & wxBU_BOTTOM )
+ msStyle |= BS_BOTTOM;
+ // flat 2d buttons
+ if ( style & wxNO_BORDER )
+ msStyle |= BS_FLAT;
+#endif // __WIN32__
+
+ return msStyle;
}
// ----------------------------------------------------------------------------
wxSize wxButton::DoGetBestSize() const
{
- wxString label = wxGetWindowText(GetHWND());
int wBtn;
- GetTextExtent(label, &wBtn, NULL);
+ GetTextExtent(wxGetWindowText(GetHWND()), &wBtn, NULL);
int wChar, hChar;
wxGetCharSize(GetHWND(), &wChar, &hChar, &GetFont());
- // add a margin - the button is wider than just its label
+ // add a margin -- the button is wider than just its label
wBtn += 3*wChar;
// the button height is proportional to the height of the font used
int hBtn = BUTTON_HEIGHT_FROM_CHAR_HEIGHT(hChar);
+ // all buttons have at least the standard size unless the user explicitly
+ // wants them to be of smaller size and used wxBU_EXACTFIT style when
+ // creating the button
+ if ( !HasFlag(wxBU_EXACTFIT) )
+ {
+ wxSize sz = GetDefaultSize();
+ if (wBtn > sz.x)
+ sz.x = wBtn;
+ if (hBtn > sz.y)
+ sz.y = hBtn;
+
+ return sz;
+ }
+
return wxSize(wBtn, hBtn);
}
/* static */
-wxSize wxButton::GetDefaultSize()
+wxSize wxButtonBase::GetDefaultSize()
{
static wxSize s_sizeBtn;
if ( s_sizeBtn.x == 0 )
{
wxScreenDC dc;
- dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+ dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
// the size of a standard button in the dialog units is 50x14,
// translate this to pixels
}
// ----------------------------------------------------------------------------
-// set this button as the default one in its panel
+// default button handling
// ----------------------------------------------------------------------------
+/*
+ "Everything you ever wanted to know about the default buttons" or "Why do we
+ have to do all this?"
+
+ In MSW the default button should be activated when the user presses Enter
+ and the current control doesn't process Enter itself somehow. This is
+ handled by ::DefWindowProc() (or maybe ::DefDialogProc()) using DM_SETDEFID
+ Another aspect of "defaultness" is that the default button has different
+ appearance: this is due to BS_DEFPUSHBUTTON style which is completely
+ separate from DM_SETDEFID stuff (!). Also note that BS_DEFPUSHBUTTON should
+ be unset if our parent window is not active so it should be unset whenever
+ we lose activation and set back when we regain it.
+
+ Final complication is that when a button is active, it should be the default
+ one, i.e. pressing Enter on a button always activates it and not another
+ one.
+
+ We handle this by maintaining a permanent and a temporary default items in
+ wxControlContainer (both may be NULL). When a button becomes the current
+ control (i.e. gets focus) it sets itself as the temporary default which
+ ensures that it has the right appearance and that Enter will be redirected
+ to it. When the button loses focus, it unsets the temporary default and so
+ the default item will be the permanent default -- that is the default button
+ if any had been set or none otherwise, which is just what we want.
+
+ NB: all this is quite complicated by now and the worst is that normally
+ it shouldn't be necessary at all as for the normal Windows programs
+ DefWindowProc() and IsDialogMessage() take care of all this
+ automatically -- however in wxWindows programs this doesn't work for
+ nested hierarchies (i.e. a notebook inside a notebook) for unknown
+ reason and so we have to reproduce all this code ourselves. It would be
+ very nice if we could avoid doing it.
+ */
+
+// set this button as the (permanently) default one in its panel
void wxButton::SetDefault()
{
wxWindow *parent = GetParent();
- wxButton *btnOldDefault = NULL;
- wxPanel *panel = wxDynamicCast(parent, wxPanel);
- if ( panel )
- {
- btnOldDefault = panel->GetDefaultItem();
- panel->SetDefaultItem(this);
- }
- if ( parent )
- {
- SendMessage(GetWinHwnd(parent), DM_SETDEFID, m_windowId, 0L);
- }
+ wxCHECK_RET( parent, _T("button without parent?") );
+
+ // set this one as the default button both for wxWindows ...
+ wxWindow *winOldDefault = parent->SetDefaultItem(this);
- if ( btnOldDefault )
+ // ... and Windows
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), FALSE);
+ SetDefaultStyle(this, TRUE);
+}
+
+// set this button as being currently default
+void wxButton::SetTmpDefault()
+{
+ wxWindow *parent = GetParent();
+
+ wxCHECK_RET( parent, _T("button without parent?") );
+
+ wxWindow *winOldDefault = parent->GetDefaultItem();
+ parent->SetTmpDefaultItem(this);
+
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), FALSE);
+ SetDefaultStyle(this, TRUE);
+}
+
+// unset this button as currently default, it may still stay permanent default
+void wxButton::UnsetTmpDefault()
+{
+ wxWindow *parent = GetParent();
+
+ wxCHECK_RET( parent, _T("button without parent?") );
+
+ parent->SetTmpDefaultItem(NULL);
+
+ wxWindow *winOldDefault = parent->GetDefaultItem();
+
+ SetDefaultStyle(this, FALSE);
+ SetDefaultStyle(wxDynamicCast(winOldDefault, wxButton), TRUE);
+}
+
+/* static */
+void
+wxButton::SetDefaultStyle(wxButton *btn, bool on)
+{
+ // we may be called with NULL pointer -- simpler to do the check here than
+ // in the caller which does wxDynamicCast()
+ if ( !btn )
+ return;
+
+ // first, let DefDlgProc() know about the new default button
+ if ( on )
{
- // remove the BS_DEFPUSHBUTTON style from the other button
- long style = GetWindowLong(GetHwndOf(btnOldDefault), GWL_STYLE);
+ // we shouldn't set BS_DEFPUSHBUTTON for any button if we don't have
+ // focus at all any more
+ if ( !wxTheApp->IsActive() )
+ return;
+
+ // look for a panel-like window
+ wxWindow *win = btn->GetParent();
+ while ( win && !win->HasFlag(wxTAB_TRAVERSAL) )
+ win = win->GetParent();
- // don't do it with the owner drawn buttons because it will reset
- // BS_OWNERDRAW style bit too (BS_OWNERDRAW & BS_DEFPUSHBUTTON != 0)!
- if ( !(style & BS_OWNERDRAW) )
+ if ( win )
{
- style &= ~BS_DEFPUSHBUTTON;
- SendMessage(GetHwndOf(btnOldDefault), BM_SETSTYLE, style, 1L);
+ ::SendMessage(GetHwndOf(win), DM_SETDEFID, btn->GetId(), 0L);
+
+ // sending DM_SETDEFID also changes the button style to
+ // BS_DEFPUSHBUTTON so there is nothing more to do
}
}
- // set this button as the default
- long style = GetWindowLong(GetHwnd(), GWL_STYLE);
- style |= BS_DEFPUSHBUTTON;
- SendMessage(GetHwnd(), BM_SETSTYLE, style, 1L);
+ // then also change the style as needed
+ long style = ::GetWindowLong(GetHwndOf(btn), GWL_STYLE);
+ if ( !(style & BS_DEFPUSHBUTTON) == on )
+ {
+ // don't do it with the owner drawn buttons because it will
+ // reset BS_OWNERDRAW style bit too (as BS_OWNERDRAW &
+ // BS_DEFPUSHBUTTON != 0)!
+ if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
+ {
+ ::SendMessage(GetHwndOf(btn), BM_SETSTYLE,
+ on ? style | BS_DEFPUSHBUTTON
+ : style & ~BS_DEFPUSHBUTTON,
+ 1L /* redraw */);
+ }
+ else // owner drawn
+ {
+ // redraw the button - it will notice itself that it's
+ // [not] the default one [any longer]
+ btn->Refresh();
+ }
+ }
+ //else: already has correct style
}
// ----------------------------------------------------------------------------
// event/message handlers
// ----------------------------------------------------------------------------
-bool wxButton::MSWCommand(WXUINT param, WXWORD id)
+bool wxButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
{
bool processed = FALSE;
switch ( param )
{
- case 1: // means that the message came from an accelerator
- case BN_CLICKED:
+ // NOTE: Apparently older versions (NT 4?) of the common controls send
+ // BN_DOUBLECLICKED but not a second BN_CLICKED for owner-drawn
+ // buttons, so in order to send two EVET_BUTTON events we should
+ // catch both types. Currently (Feb 2003) up-to-date versions of
+ // win98, win2k and winXP all send two BN_CLICKED messages for
+ // all button types, so we don't catch BN_DOUBLECLICKED anymore
+ // in order to not get 3 EVT_BUTTON events. If this is a problem
+ // then we need to figure out which version of the comctl32 changed
+ // this behaviour and test for it.
+
+ case 1: // message came from an accelerator
+ case BN_CLICKED: // normal buttons send this
processed = SendClickEvent();
break;
}
long wxButton::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
- // make sure that we won't have BS_DEFPUSHBUTTON style any more if the
- // focus is being transfered to another button with the same parent -
- // otherwise, we could finish with 2 default buttons inside one panel
- if ( (nMsg == WM_KILLFOCUS) &&
- (GetWindowLong(GetHwnd(), GWL_STYLE) & BS_DEFPUSHBUTTON) )
+ // when we receive focus, we want to temporary become the default button in
+ // our parent panel so that pressing "Enter" would activate us -- and when
+ // losing it we should restore the previous default button as well
+ if ( nMsg == WM_SETFOCUS )
{
- wxWindow *parent = GetParent();
- wxWindow *win = wxFindWinFromHandle((WXHWND)wParam);
- if ( win && win->GetParent() == parent )
- {
- wxPanel *panel = wxDynamicCast(parent, wxPanel);
- if ( panel )
- {
- panel->SetDefaultItem(this);
- }
- // else: I don't know what to do - we'll still have the problem
- // with multiple default buttons in a dialog...
- }
+ SetTmpDefault();
+
+ // let the default processing take place too
+ }
+ else if ( nMsg == WM_KILLFOCUS )
+ {
+ UnsetTmpDefault();
+ }
+ else if ( nMsg == WM_LBUTTONDBLCLK )
+ {
+ // emulate a click event to force an owner-drawn button to change its
+ // appearance - without this, it won't do it
+ (void)wxControl::MSWWindowProc(WM_LBUTTONDOWN, wParam, lParam);
+
+ // and continue with processing the message normally as well
}
// let the base class do all real processing
COLORREF colOld = SetTextColor(hdc, col);
int modeOld = SetBkMode(hdc, TRANSPARENT);
- DrawText(hdc, text, text.length(), pRect,
- DT_CENTER | DT_VCENTER | DT_SINGLELINE);
+ // Note: we must have DT_SINGLELINE for DT_VCENTER to work.
+ ::DrawText(hdc, text, text.length(), pRect, DT_SINGLELINE | DT_CENTER | DT_VCENTER);
SetBkMode(hdc, modeOld);
SetTextColor(hdc, colOld);
static void DrawRect(HDC hdc, const RECT& r)
{
- MoveToEx(hdc, r.left, r.top, NULL);
- LineTo(hdc, r.right, r.top);
- LineTo(hdc, r.right, r.bottom);
- LineTo(hdc, r.left, r.bottom);
- LineTo(hdc, r.left, r.top);
+ wxDrawLine(hdc, r.left, r.top, r.right, r.top);
+ wxDrawLine(hdc, r.right, r.top, r.right, r.bottom);
+ wxDrawLine(hdc, r.right, r.bottom, r.left, r.bottom);
+ wxDrawLine(hdc, r.left, r.bottom, r.left, r.top);
}
void wxButton::MakeOwnerDrawn()
{
long style = GetWindowLong(GetHwnd(), GWL_STYLE);
- if ( !(style & BS_OWNERDRAW) )
+ if ( (style & BS_OWNERDRAW) != BS_OWNERDRAW )
{
// make it so
style |= BS_OWNERDRAW;
The button frame looks like this normally:
WWWWWWWWWWWWWWWWWWB
- W GB
- W GB
- W GB where W, G, B are white, grey and black pixels
- W GB
+ WHHHHHHHHHHHHHHHHGB W = white (HILIGHT)
+ WH GB H = light grey (LIGHT)
+ WH GB G = dark grey (SHADOW)
+ WH GB B = black (DKSHADOW)
+ WH GB
WGGGGGGGGGGGGGGGGGB
BBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBB
BWWWWWWWWWWWWWWWWBB
- BW GBB
- BW GBB
+ BWHHHHHHHHHHHHHHGBB
+ BWH GBB
+ BWH GBB
BWGGGGGGGGGGGGGGGBB
BBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBB
BG GB
BG GB
BG GB
+ BG GB
BGGGGGGGGGGGGGGGGGB
BBBBBBBBBBBBBBBBBBB
*/
RECT r;
CopyRect(&r, &rectBtn);
- HPEN hpenBlack = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DDKSHADOW)),
- hpenGrey = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DSHADOW)),
- hpenWhite = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DHILIGHT));
+ HPEN hpenBlack = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DDKSHADOW)),
+ hpenGrey = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DSHADOW)),
+ hpenLightGr = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DLIGHT)),
+ hpenWhite = CreatePen(PS_SOLID, 1, GetSysColor(COLOR_3DHILIGHT));
HPEN hpenOld = (HPEN)SelectObject(hdc, hpenBlack);
InflateRect(&r, -1, -1);
}
- MoveToEx(hdc, r.left, r.bottom, NULL);
- LineTo(hdc, r.right, r.bottom);
- LineTo(hdc, r.right, r.top - 1);
+ wxDrawLine(hdc, r.left, r.bottom, r.right, r.bottom);
+ wxDrawLine(hdc, r.right, r.bottom, r.right, r.top - 1);
(void)SelectObject(hdc, hpenWhite);
- MoveToEx(hdc, r.left, r.bottom - 1, NULL);
- LineTo(hdc, r.left, r.top);
- LineTo(hdc, r.right, r.top);
+ wxDrawLine(hdc, r.left, r.bottom - 1, r.left, r.top);
+ wxDrawLine(hdc, r.left, r.top, r.right, r.top);
+
+ (void)SelectObject(hdc, hpenLightGr);
+ wxDrawLine(hdc, r.left + 1, r.bottom - 2, r.left + 1, r.top + 1);
+ wxDrawLine(hdc, r.left + 1, r.top + 1, r.right - 1, r.top + 1);
(void)SelectObject(hdc, hpenGrey);
- MoveToEx(hdc, r.left + 1, r.bottom - 1, NULL);
- LineTo(hdc, r.right - 1, r.bottom - 1);
- LineTo(hdc, r.right - 1, r.top);
+ wxDrawLine(hdc, r.left + 1, r.bottom - 1, r.right - 1, r.bottom - 1);
+ wxDrawLine(hdc, r.right - 1, r.bottom - 1, r.right - 1, r.top);
}
(void)SelectObject(hdc, hpenOld);
DeleteObject(hpenWhite);
+ DeleteObject(hpenLightGr);
DeleteObject(hpenGrey);
DeleteObject(hpenBlack);
}
DrawFocusRect(hdc, &rectFocus);
}
+ if ( pushed )
+ {
+ // the label is shifted by 1 pixel to create "pushed" effect
+ OffsetRect(&rectBtn, 1, 1);
+ }
+
DrawButtonText(hdc, &rectBtn, GetLabel(),
state & ODS_DISABLED ? GetSysColor(COLOR_GRAYTEXT)
: colFg);
::DeleteObject(hbrushBackground);
-#if 0
- wxString s = "button state: ";
- if ( selected )
- s += "selected ";
- if ( pushed )
- s += "pushed ";
- if ( state & ODS_FOCUS )
- s += "focused ";
- wxLogStatus(s);
-#endif
-
return TRUE;
}
#endif // __WIN32__
+
+#endif // wxUSE_BUTTON
+
projects / wxWidgets.git / blobdiff