CScrollerButton Class Reference

This OIL class extends standard Windows bitmapped buttons so that they respond to clicks with the right mouse-button, and send notification messages as long as they are held down. More...

#include <scrlbutn.h>

List of all members.

Public Types
enum	Orientation { UP, DOWN, LEFT, RIGHT }
Public Member Functions
	CScrollerButton (Orientation ort, UINT32 msg)
	Constructs a CScrollerButton with the appropriate face.
virtual BOOL	Create (LPCTSTR, DWORD style, const RECT &rect, CWnd *parent, UINT32 id)
Protected Member Functions
afx_msg void	OnLButtonDown (UINT32 nFlags, CPoint point)
	We must override the default handling for push-buttons because scroll-bar buttons generate a sequence of messages until they are released, whilst normal buttons generate only one message when pressed. This member function passes the message on to HandleButtonDown() with a FALSE parameter.
afx_msg void	OnLButtonUp (UINT32 nFlags, CPoint point)
	Passes message on to HandleButtonUp().
afx_msg void	OnRButtonDown (UINT32 nFlags, CPoint point)
	We must override the default handling for push-buttons because Windows buttons do not respond to clicks with the right mouse-button. This member function passes the message on to HandleButtonDown() with a TRUE parameter, after calling CButton::SetState(TRUE) to "simulate" the button being clicked.
afx_msg void	OnRButtonUp (UINT32 nFlags, CPoint point)
	Passes message on to HandleButtonUp(), after calling CButton::SetState(FALSE) to draw the button "undepressed".
afx_msg void	OnTimer (UINT32 nIDEvent)
	Responds to the elapsed timer, set in HandleButtonDown(), by repeating the last "button-clicked" message sent to the parent CScroller. This allows the button to send a stream of messages until it is released - normally, Windows buttons send only one message per click.
afx_msg void	OnCancelMode ()
	Sent by windows if the user hits ESCAPE or the dialog of another app. pops up in the middle of some mouse capturing. Gives this window a chance to release the captured mouse and kill any running timer.
afx_msg void	OnLButtonDblClk (UINT32 nFlags, CPoint point)
	Calls CScrollerButton::OnLButtonDown(), to convert a double-click into a single click (MFC buttons don't normally respond to double-clicks).
afx_msg void	OnRButtonDblClk (UINT32 nFlags, CPoint point)
	Calls CScrollerButton::OnRButtonDown(), to convert a double-click into a single click (MFC buttons don't normally respond to double-clicks).
Private Member Functions
virtual BOOL	LoadOEMBitmaps (UINT32 upID, UINT32 downID, UINT32 disableID)
	Some display drivers, such as the ET4000, do not contain a "disabled" bitmap for scroll bars buttons. In this case the function substitutes the "up" bitmap for the "disabled" bitmap.
void	HandleButtonDown (BOOL reverse)
	Captures the mouse, to guarantee receiving a button-up message some time in the future. Sets a timer in case that the button is held down and further messages must be processed (Windows buttons only send one notification message, no matter how long they are held down for). Sends a private "button clicked" message to the parent CScroller object.
void	HandleButtonUp ()
	Releases the captured mouse and kills the timer set by HandleButtonDown().
void	DrawItem (LPDRAWITEMSTRUCT lpDrawItemStruct)
BOOL	PlotMaskedBitmap (CDC *destDC, CBitmap *srcBitmap, INT32 SrcOffset, INT32 xPlotOffset, INT32 yPlotOffset, INT32 width, INT32 height)
Private Attributes
Orientation	Orient
BOOL	Reversed
BOOL	TimerOn
UINT32	Message
Static Private Attributes
static UINT32	BitmapNames [4][3]

---

Detailed Description

This OIL class extends standard Windows bitmapped buttons so that they respond to clicks with the right mouse-button, and send notification messages as long as they are held down.

Author:

Justin_Flude (Xara Group Ltd) <camelotdev@xara.com>

Date:

ages ago

Definition at line 135 of file scrlbutn.h.

---

Member Enumeration Documentation

enum CScrollerButton::Orientation

Enumerator: UP  DOWN  LEFT  RIGHT  Definition at line 142 of file scrlbutn.h. { UP, DOWN, LEFT, RIGHT };

---

Constructor & Destructor Documentation

CScrollerButton::CScrollerButton (  CScrollerButton::Orientation  ort, UINT32  msg )

Constructs a CScrollerButton with the appropriate face. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: The  orientation of the bitmap on the button's face, the message the button [INPUTS] button should send the CScroller parent when it is clicked. -  [OUTPUTS] Returns: - Errors: ENSURE failure if, for any stupid reason, the orientation is invalid. Scope: Public See also: CScrollerButton::Create(); CScroller::OnCreate() Definition at line 166 of file scrlbutn.cpp. : CBitmapButton(), Orient(ort), Message(msg) { // So far, very little to do here. ENSURE(ort >= CScrollerButton::UP && ort <= CScrollerButton::RIGHT, "Unknown orientation code passed to scroller button constructor!\n"); }

---

Member Function Documentation

BOOL CScrollerButton::Create (  LPCTSTR  , DWORD  style, const RECT &  rect, CWnd *  parent, UINT32  id )  [virtual]

Definition at line 195 of file scrlbutn.cpp. { return CBitmapButton::Create("", style | WS_CLIPSIBLINGS | WS_VISIBLE | WS_CHILD | BS_OWNERDRAW | BS_PUSHBUTTON, rect, parent, id) && LoadOEMBitmaps(BitmapNames[Orient][0], // button up BitmapNames[Orient][1], // button down BitmapNames[Orient][2]); // disabled }

void CScrollerButton::DrawItem (  LPDRAWITEMSTRUCT  lpDrawItemStruct  )  [private]

Definition at line 657 of file scrlbutn.cpp. { ASSERT(lpDIS != NULL); // must have at least the first bitmap loaded before calling DrawItem ASSERT(m_bitmap.m_hObject != NULL); // required // use the main bitmap for up, the selected bitmap for down CBitmap* pBitmap = &m_bitmap; UINT32 state = lpDIS->itemState; if ((state & ODS_SELECTED) && m_bitmapSel.m_hObject != NULL) pBitmap = &m_bitmapSel; #ifndef _MAC else if ((state & ODS_FOCUS) && m_bitmapFocus.m_hObject != NULL) #else else if ((state & ODS_FOCUS) && m_bitmapFocus.m_hObject != NULL && (GetParent()->GetStyle() & DS_WINDOWSUI)) #endif pBitmap = &m_bitmapFocus; // third image for focused else if ((state & ODS_DISABLED) && m_bitmapDisabled.m_hObject != NULL) pBitmap = &m_bitmapDisabled; // last image for disabled CDC* pDC = CDC::FromHandle(lpDIS->hDC); // New masked version //------------------------------------------------------------------------------ CRect rect; rect.CopyRect(&lpDIS->rcItem); if(!IS_CHICAGO) // UIC { // draw the whole button PlotMaskedBitmap(pDC,pBitmap,0,rect.left, rect.top, rect.Width(), rect.Height()); } else { UINT32 Flags =0; switch(Orient) { case UP: Flags = DFCS_SCROLLUP; break; case DOWN: Flags = DFCS_SCROLLDOWN; break; case LEFT: Flags = DFCS_SCROLLLEFT; break; case RIGHT: Flags = DFCS_SCROLLRIGHT; break; } if (state & ODS_SELECTED) Flags |= DFCS_PUSHED; pDC->DrawFrameControl(&rect,DFC_SCROLL, Flags); } //------------------------------------------------------------------------------- // Old "scrcopy" version //------------------------------------------------------------------------------- /* CDC memDC; memDC.CreateCompatibleDC(pDC); CBitmap* pOld = memDC.SelectObject(pBitmap); if (pOld == NULL) return; // destructors will clean up CRect rect; rect.CopyRect(&lpDIS->rcItem); pDC->BitBlt(rect.left, rect.top, rect.Width(), rect.Height(), &memDC, 0, 0, SRCCOPY); memDC.SelectObject(pOld); */ //------------------------------------------------------------------------------- }

void CScrollerButton::HandleButtonDown (  BOOL  reverse  )  [private]

Captures the mouse, to guarantee receiving a button-up message some time in the future. Sets a timer in case that the button is held down and further messages must be processed (Windows buttons only send one notification message, no matter how long they are held down for). Sends a private "button clicked" message to the parent CScroller object. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: A  boolean which if TRUE indicates that the button is responding to a click [INPUTS] with the right mouse button, so the scroll is in the opposite direction. -  [OUTPUTS] Returns: - Errors: - Scope: Private See also: CScrollerButton::HandleButtonUp(); CScrollerButton::OnLButtonDown(); CScrollerButton::OnRButtonDown(); CScrollerButton::OnTimer() CScroller::OnDecBtnClicked(); CScroller::OnIncBtnClicked() Definition at line 276 of file scrlbutn.cpp. { // On the initial click, we set up an auto-repeat timer to start after the configured // keyboard auto-repeat delay UINT32 CallbackTime = 1000; UINT32 RepsPerSec; ::SystemParametersInfo(SPI_GETKEYBOARDDELAY, 0, &RepsPerSec, 0); RepsPerSec = 4 - RepsPerSec; if (RepsPerSec > 1) CallbackTime = (UINT32) 1000 / RepsPerSec; TimerOn = ::FixSetTimer(m_hWnd, 3, CallbackTime, 0); #ifdef _DEBUG if (!TimerOn) TRACE( _T("Unable to allocate a timer in CScrollerButton::HandleButtonDown()!\n")); #endif // _DEBUG SetCapture(); GetParent()->SendMessage(Message, WPARAM(Reversed = reverse)); SetState(TRUE); }

void CScrollerButton::HandleButtonUp (   )  [private]

Releases the captured mouse and kills the timer set by HandleButtonDown(). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - Scope: Private See also: CScrollerButton::HandleButtonDown(); CScrollerButton::OnLButtonUp(); CScrollerButton::OnRButtonUp(); CScrollerButton::OnTimer() Definition at line 317 of file scrlbutn.cpp. { ReleaseCapture(); if (TimerOn) { ::FixKillTimer(m_hWnd, 3); TimerOn = FALSE; } SetState(FALSE); // tell people things have changed on screen BROADCAST_TO_ALL(ScreenChangeMsg(TRUE)); }

BOOL CScrollerButton::LoadOEMBitmaps (  UINT32  upID, UINT32  downID, UINT32  disableID )  [private, virtual]

Some display drivers, such as the ET4000, do not contain a "disabled" bitmap for scroll bars buttons. In this case the function substitutes the "up" bitmap for the "disabled" bitmap. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: The  resource identifier of the bitmap displayed on the button when it is [INPUTS] "up", ie. not clicked; the ID of the "down" bitmap; the ID of the "disabled" bitmap. -  [OUTPUTS] Returns: TRUE if the bitmaps are successfully extracted from the display driver, FALSE if some essential bitmaps cannot be extracted. Errors: - Scope: Private See also: CScrollerButton::Create() Definition at line 230 of file scrlbutn.cpp. { m_bitmap.DeleteObject(); m_bitmapSel.DeleteObject(); m_bitmapDisabled.DeleteObject(); #ifndef _MAC // The up/down bitmaps are essential and must be present. if (!m_bitmap.LoadOEMBitmap(upID) || !m_bitmapSel.LoadOEMBitmap(downID)) return FALSE; // The disabled bitmap is not essential, and if not present, the up // bitmap can be substituted for it. if (!m_bitmapDisabled.LoadOEMBitmap(disableID)) m_bitmapDisabled.LoadOEMBitmap(upID); #endif return TRUE; }

void CScrollerButton::OnCancelMode (   )  [protected]

Sent by windows if the user hits ESCAPE or the dialog of another app. pops up in the middle of some mouse capturing. Gives this window a chance to release the captured mouse and kill any running timer. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonDown(); CScrollerButton::OnTimer(); CScrollerButton::HandleButtonUp() Definition at line 535 of file scrlbutn.cpp. { CBitmapButton::OnCancelMode(); if (TimerOn) HandleButtonUp(); }

void CScrollerButton::OnLButtonDblClk (  UINT32  nFlags, CPoint  point )  [protected]

Calls CScrollerButton::OnLButtonDown(), to convert a double-click into a single click (MFC buttons don't normally respond to double-clicks). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::OnLButtonDown(); CScrollerButton::OnRButtonDblClk() Definition at line 452 of file scrlbutn.cpp. { OnLButtonDown(nFlags, point); }

void CScrollerButton::OnLButtonDown (  UINT32  nFlags, CPoint  point )  [protected]

We must override the default handling for push-buttons because scroll-bar buttons generate a sequence of messages until they are released, whilst normal buttons generate only one message when pressed. This member function passes the message on to HandleButtonDown() with a FALSE parameter. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonDown(); CScrollerButton::OnLButtonUp() Definition at line 354 of file scrlbutn.cpp. { CBitmapButton::OnLButtonDown(nFlags, point); HandleButtonDown(FALSE); }

void CScrollerButton::OnLButtonUp (  UINT32  nFlags, CPoint  point )  [protected]

Passes message on to HandleButtonUp(). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonUp(); CScrollerButton::OnLButtonDown() Definition at line 377 of file scrlbutn.cpp. { CBitmapButton::OnLButtonUp(nFlags, point); SetState(FALSE); HandleButtonUp(); }

void CScrollerButton::OnRButtonDblClk (  UINT32  nFlags, CPoint  point )  [protected]

Calls CScrollerButton::OnRButtonDown(), to convert a double-click into a single click (MFC buttons don't normally respond to double-clicks). Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::OnRButtonDown(); CScrollerButton::OnLButtonDblClk() Definition at line 475 of file scrlbutn.cpp. { OnRButtonDown(nFlags, point); }

void CScrollerButton::OnRButtonDown (  UINT32  nFlags, CPoint  point )  [protected]

We must override the default handling for push-buttons because Windows buttons do not respond to clicks with the right mouse-button. This member function passes the message on to HandleButtonDown() with a TRUE parameter, after calling CButton::SetState(TRUE) to "simulate" the button being clicked. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonDown(); CScrollerButton::OnRButtonUp() Definition at line 404 of file scrlbutn.cpp. { SetState(TRUE); HandleButtonDown(TRUE); }

void CScrollerButton::OnRButtonUp (  UINT32  nFlags, CPoint  point )  [protected]

Passes message on to HandleButtonUp(), after calling CButton::SetState(FALSE) to draw the button "undepressed". Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: Some  flags detailing which buttons and keys were down when the mouse message [INPUTS] was generated; the coordinates of the mouse cursor. -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonUp(); CScrollerButton::OnRButtonDown() Definition at line 428 of file scrlbutn.cpp. { SetState(FALSE); HandleButtonUp(); }

void CScrollerButton::OnTimer (  UINT32  nIDEvent  )  [protected]

Responds to the elapsed timer, set in HandleButtonDown(), by repeating the last "button-clicked" message sent to the parent CScroller. This allows the button to send a stream of messages until it is released - normally, Windows buttons send only one message per click. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: ages ago Parameters: The  timer's numeric identifier (not used). [INPUTS] -  [OUTPUTS] Returns: - Errors: - Scope: Protected See also: CScrollerButton::HandleButtonDown(); CScrollerButton::HandleButtonUp() Definition at line 499 of file scrlbutn.cpp. { // This checks for auto-repeat on the scroll button at the keyboard auto-repeat rate UINT32 CallbackTime = 1000; UINT32 RepsPerSec; ::SystemParametersInfo(SPI_GETKEYBOARDSPEED, 0, &RepsPerSec, 0); CallbackTime = (UINT32) 1000 / (RepsPerSec + 1); TimerOn = ::FixSetTimer(m_hWnd, 3, CallbackTime, 0); #ifdef _DEBUG if (!TimerOn) TRACE( _T("Unable to allocate a timer in CScrollerButton::OnTimer()!\n")); #endif // _DEBUG GetParent()->SendMessage(Message, WPARAM(Reversed)); }

BOOL CScrollerButton::PlotMaskedBitmap (  CDC *  destDC, CBitmap *  srcBitmap, INT32  SrcOffset, INT32  xPlotOffset, INT32  yPlotOffset, INT32  width, INT32  height )  [private]

Definition at line 594 of file scrlbutn.cpp. { ERROR2IF(srcBitmap == NULL,FALSE,"NULL Bitmap in PlotMaskedBitmap()"); ERROR2IF(destDC == NULL,FALSE,"NULL DC in PlotMaskedBitmap()"); // always fill the entire background with BTNFACE to make sure we don't // miss any pixels PatB(destDC, 0, 0, width, height, GetSysColor(COLOR_BTNFACE)); // create a screen dc CDC scrDC ; scrDC.CreateCompatibleDC(destDC); // and select the bitmap into it CBitmap* OldSrcBitmap = (CBitmap *) scrDC.SelectObject(srcBitmap); // create a mask for the button glyph... First a DC CDC hDCMono ; hDCMono.CreateCompatibleDC(NULL); // create a mono bitmap for the mask CBitmap hbmMono ; hbmMono.CreateBitmap(width, height, 1, 1, NULL); CBitmap * oldmonobitmap = (CBitmap *)hDCMono.SelectObject(&hbmMono); // initalize the bitmapto white (all 1's) hDCMono.PatBlt(0, 0, width, height, WHITENESS); // plot all non-lightgrey pixels in the glyph as black in our mask scrDC.SetBkColor( RGB(192,192,192)); hDCMono.BitBlt(xPlotOffset,yPlotOffset, width, height, &scrDC, SrcOffset, 0, SRCCOPY); destDC->SetTextColor(0L); // 0's in mono -> 0 (for ROP) destDC->SetBkColor((COLORREF)0x00FFFFFFL); // 1's in mono -> 1 // plot the glyph destDC->BitBlt( xPlotOffset, yPlotOffset, width, height, &scrDC, SrcOffset, 0, SRCCOPY); // fill with the normal BTNFACE colour CBrush HighlightBrush ; HighlightBrush.CreateSolidBrush(GetSysColor(COLOR_BTNFACE)); CBrush* hbrOld = (CBrush *) destDC->SelectObject(&HighlightBrush); if (hbrOld != NULL) { // draw highlight color where we have 0's in the mask destDC->BitBlt( xPlotOffset,yPlotOffset, width, height, &hDCMono, 0, 0, ROP_DSPDxax); destDC->SelectObject(hbrOld); } // clean up DC's hDCMono.SelectObject(oldmonobitmap); scrDC.SelectObject(OldSrcBitmap); return TRUE; }

---

Member Data Documentation

UINT32 CScrollerButton::BitmapNames [static, private]

Initial value: { { OBM_UPARROW, OBM_UPARROWD, OBM_UPARROWI }, { OBM_DNARROW, OBM_DNARROWD, OBM_DNARROWI }, { OBM_LFARROW, OBM_LFARROWD, OBM_LFARROWI }, { OBM_RGARROW, OBM_RGARROWD, OBM_RGARROWI } } Definition at line 149 of file scrlbutn.h.

UINT32 CScrollerButton::Message [private]

Definition at line 154 of file scrlbutn.h.

Orientation CScrollerButton::Orient [private]

Definition at line 151 of file scrlbutn.h.

BOOL CScrollerButton::Reversed [private]

Definition at line 152 of file scrlbutn.h.

BOOL CScrollerButton::TimerOn [private]

Definition at line 153 of file scrlbutn.h.

---

The documentation for this class was generated from the following files:

• wxOil/scrlbutn.h (r1785/r751)
• wxOil/scrlbutn.cpp (r1785/r1282)

---