reactos/wine
1
0
Fork 0
mirror of https://github.com/reactos/wine.git synced 2024-11-25 20:59:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
49b7fdcfc0
wine/dlls/comctl32/progress.c
Frank Richter 54de614906 Split up the drawing code into a set of smaller functions and also 
moved some common computations into helper functions. All that to
facilitate the implementation of the forthcoming theming support.
2005-07-27 12:07:03 +00:00

607 lines
18 KiB
C
Raw Blame History

/*
* Progress control
*
* Copyright 1997, 2002 Dimitrie O. Paun
* Copyright 1998, 1999 Eric Kohl
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* NOTE
*
* This code was audited for completeness against the documented features
* of Comctl32.dll version 6.0 on Sep. 9, 2002, by Dimitrie O. Paun.
*
* Unless otherwise noted, we believe this code to be complete, as per
* the specification mentioned above.
* If you discover missing features, or bugs, please note them below.
*
*/
#include <stdarg.h>
#include <string.h>
#include "windef.h"
#include "winbase.h"
#include "wingdi.h"
#include "winuser.h"
#include "winnls.h"
#include "commctrl.h"
#include "comctl32.h"
#include "wine/debug.h"
WINE_DEFAULT_DEBUG_CHANNEL(progress);
typedef struct
{
HWND Self; /* The window handle for this control */
INT CurVal; /* Current progress value */
INT MinVal; /* Minimum progress value */
INT MaxVal; /* Maximum progress value */
INT Step; /* Step to use on PMB_STEPIT */
INT MarqueePos; /* Marquee animation position */
BOOL Marquee; /* Whether the marquee animation is enabled */
COLORREF ColorBar; /* Bar color */
COLORREF ColorBk; /* Background color */
HFONT Font; /* Handle to font (not unused) */
} PROGRESS_INFO;
/* Control configuration constants */
#define LED_GAP 2
#define MARQUEE_LEDS 5
#define ID_MARQUEE_TIMER 1
/* Helper to compute size of a progress bar chunk ("led"). */
static inline int get_led_size ( PROGRESS_INFO *infoPtr, LONG style,
const RECT* rect)
{
if (style & PBS_VERTICAL)
return MulDiv (rect->right - rect->left, 2, 3);
else
return MulDiv (rect->bottom - rect->top, 2, 3);
}
/* Compute the extend of the bar */
static inline int get_bar_size( LONG style, const RECT* rect )
{
if (style & PBS_VERTICAL)
return rect->bottom - rect->top;
else
return rect->right - rect->left;
}
/* Compute the pixel position of a progress value */
static inline int get_bar_position( PROGRESS_INFO *infoPtr, LONG style,
const RECT* rect, INT value )
{
return MulDiv (value - infoPtr->MinVal, get_bar_size (style, rect),
infoPtr->MaxVal - infoPtr->MinVal);
}
/***********************************************************************
* PROGRESS_Invalidate
*
* Invalide the range between old and new pos.
*/
static void PROGRESS_Invalidate( PROGRESS_INFO *infoPtr, INT old, INT new )
{
LONG style = GetWindowLongW (infoPtr->Self, GWL_STYLE);
RECT rect;
int oldPos, newPos;
GetClientRect (infoPtr->Self, &rect);
InflateRect(&rect, -1, -1);
oldPos = get_bar_position( infoPtr, style, &rect, old );
newPos = get_bar_position( infoPtr, style, &rect, new );
if (style & PBS_VERTICAL)
{
rect.top = rect.bottom - max( oldPos, newPos );
rect.bottom = rect.bottom - min( oldPos, newPos );
if (!(style & PBS_SMOOTH)) rect.top -=
get_led_size (infoPtr, style, &rect);
}
else
{
rect.left = min( oldPos, newPos );
rect.right = max( oldPos, newPos );
if (!(style & PBS_SMOOTH)) rect.right +=
get_led_size (infoPtr, style, &rect);
}
InvalidateRect( infoPtr->Self, &rect, oldPos > newPos );
}
/* Information for a progress bar drawing helper */
typedef struct tagProgressDrawInfo
{
HDC hdc;
RECT rect;
HBRUSH hbrBar;
HBRUSH hbrBk;
int ledW;
} ProgressDrawInfo;
typedef void (*ProgressDrawProc)(const ProgressDrawInfo* di, int start, int end);
/* draw solid horizontal bar from 'start' to 'end' */
static void draw_solid_bar_H (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
r.left = di->rect.left + start;
r.top = di->rect.top;
r.right = di->rect.left + end;
r.bottom = di->rect.bottom;
FillRect (di->hdc, &r, di->hbrBar);
}
/* draw solid horizontal background from 'start' to 'end' */
static void draw_solid_bkg_H (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
r.left = di->rect.left + start;
r.top = di->rect.top;
r.right = di->rect.left + end;
r.bottom = di->rect.bottom;
FillRect (di->hdc, &r, di->hbrBk);
}
/* draw solid vertical bar from 'start' to 'end' */
static void draw_solid_bar_V (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
r.left = di->rect.left;
r.top = di->rect.bottom - end;
r.right = di->rect.right;
r.bottom = di->rect.bottom - start;
FillRect (di->hdc, &r, di->hbrBar);
}
/* draw solid vertical background from 'start' to 'end' */
static void draw_solid_bkg_V (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
r.left = di->rect.left;
r.top = di->rect.bottom - end;
r.right = di->rect.right;
r.bottom = di->rect.bottom - start;
FillRect (di->hdc, &r, di->hbrBk);
}
/* draw chunky horizontal bar from 'start' to 'end' */
static void draw_chunk_bar_H (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
int right = di->rect.left + end;
r.left = di->rect.left + start;
r.top = di->rect.top;
r.bottom = di->rect.bottom;
while (r.left < right)
{
r.right = min (r.left + di->ledW, right);
FillRect (di->hdc, &r, di->hbrBar);
r.left = r.right;
r.right = min (r.left + LED_GAP, right);
FillRect (di->hdc, &r, di->hbrBk);
r.left = r.right;
}
}
/* draw chunky vertical bar from 'start' to 'end' */
static void draw_chunk_bar_V (const ProgressDrawInfo* di, int start, int end)
{
RECT r;
int top = di->rect.bottom - end;
r.left = di->rect.left;
r.right = di->rect.right;
r.bottom = di->rect.bottom - start;
while (r.bottom > top)
{
r.top = max (r.bottom - di->ledW, top);
FillRect (di->hdc, &r, di->hbrBar);
r.bottom = r.top;
r.top = max (r.bottom - LED_GAP, top);
FillRect (di->hdc, &r, di->hbrBk);
r.bottom = r.top;
}
}
/* drawing functions for "classic" style */
static const ProgressDrawProc drawProcClassic[8] = {
/* Smooth */
/* Horizontal */
draw_solid_bar_H, draw_solid_bkg_H,
/* Vertical */
draw_solid_bar_V, draw_solid_bkg_V,
/* Chunky */
/* Horizontal */
draw_chunk_bar_H, draw_solid_bkg_H,
/* Vertical */
draw_chunk_bar_V, draw_solid_bkg_V,
};
/***********************************************************************
* PROGRESS_Draw
* Draws the progress bar.
*/
static LRESULT PROGRESS_Draw (PROGRESS_INFO *infoPtr, HDC hdc)
{
int barSize;
DWORD dwStyle;
BOOL barSmooth;
const ProgressDrawProc* drawProcs;
ProgressDrawInfo pdi;
TRACE("(infoPtr=%p, hdc=%p)\n", infoPtr, hdc);
pdi.hdc = hdc;
/* get the required bar brush */
if (infoPtr->ColorBar == CLR_DEFAULT)
pdi.hbrBar = GetSysColorBrush(COLOR_HIGHLIGHT);
else
pdi.hbrBar = CreateSolidBrush (infoPtr->ColorBar);
if (infoPtr->ColorBk == CLR_DEFAULT)
pdi.hbrBk = GetSysColorBrush(COLOR_3DFACE);
else
pdi.hbrBk = CreateSolidBrush(infoPtr->ColorBk);
/* get the window style */
dwStyle = GetWindowLongW (infoPtr->Self, GWL_STYLE);
/* get client rectangle */
GetClientRect (infoPtr->Self, &pdi.rect);
FrameRect( hdc, &pdi.rect, pdi.hbrBk );
InflateRect(&pdi.rect, -1, -1);
/* compute some drawing parameters */
barSmooth = (dwStyle & PBS_SMOOTH);
drawProcs = &(drawProcClassic[(barSmooth ? 0 : 4)
+ ((dwStyle & PBS_VERTICAL) ? 2 : 0)]);
barSize = get_bar_size( dwStyle, &pdi.rect );
if (!barSmooth)
pdi.ledW = get_led_size( infoPtr, dwStyle, &pdi.rect);
/* now draw the bar */
if (dwStyle & PBS_MARQUEE)
{
const int ledW = !barSmooth ? (pdi.ledW + LED_GAP) : 1;
const int leds = (barSize + ledW - 1) / ledW;
const int ledMEnd = infoPtr->MarqueePos + MARQUEE_LEDS;
if (ledMEnd > leds)
{
/* case 1: the marquee bar extends over the end and wraps around to
* the start */
const int gapStart = max((ledMEnd - leds) * ledW, 0);
const int gapEnd = min(infoPtr->MarqueePos * ledW, barSize);
drawProcs[0]( &pdi, 0, gapStart);
drawProcs[1]( &pdi, gapStart, gapEnd);
drawProcs[0]( &pdi, gapEnd, barSize);
}
else
{
/* case 2: the marquee bar is between start and end */
const int barStart = infoPtr->MarqueePos * ledW;
const int barEnd = min (ledMEnd * ledW, barSize);
drawProcs[1]( &pdi, 0, barStart);
drawProcs[0]( &pdi, barStart, barEnd);
drawProcs[1]( &pdi, barEnd, barSize);
}
}
else
{
int barEnd = get_bar_position( infoPtr, dwStyle, &pdi.rect,
infoPtr->CurVal);
if (!barSmooth)
{
const int ledW = pdi.ledW + LED_GAP;
barEnd = min (((barEnd + ledW - 1) / ledW) * ledW, barSize);
}
drawProcs[0]( &pdi, 0, barEnd);
drawProcs[1]( &pdi, barEnd, barSize);
}
/* delete bar brush */
if (infoPtr->ColorBar != CLR_DEFAULT) DeleteObject (pdi.hbrBar);
if (infoPtr->ColorBk != CLR_DEFAULT) DeleteObject (pdi.hbrBk);
return 0;
}
/***********************************************************************
* PROGRESS_Paint
* Draw the progress bar. The background need not be erased.
* If dc!=0, it draws on it
*/
static LRESULT PROGRESS_Paint (PROGRESS_INFO *infoPtr, HDC hdc)
{
PAINTSTRUCT ps;
if (hdc) return PROGRESS_Draw (infoPtr, hdc);
hdc = BeginPaint (infoPtr->Self, &ps);
PROGRESS_Draw (infoPtr, hdc);
EndPaint (infoPtr->Self, &ps);
return 0;
}
/***********************************************************************
* PROGRESS_Timer
* Handle the marquee timer messages
*/
static LRESULT PROGRESS_Timer (PROGRESS_INFO *infoPtr, INT idTimer)
{
if(idTimer == ID_MARQUEE_TIMER)
{
LONG style = GetWindowLongW (infoPtr->Self, GWL_STYLE);
RECT rect;
int ledWidth, leds;
GetClientRect (infoPtr->Self, &rect);
if(!(style & PBS_SMOOTH))
ledWidth = get_led_size( infoPtr, style, &rect ) + LED_GAP;
else
ledWidth = 1;
leds = (get_bar_size( style, &rect ) + ledWidth - 1) /
ledWidth;
/* increment the marquee progress */
if(++infoPtr->MarqueePos > leds)
{
infoPtr->MarqueePos = 0;
}
InvalidateRect(infoPtr->Self, &rect, FALSE);
}
return 0;
}
/***********************************************************************
* PROGRESS_CoercePos
* Makes sure the current position (CurVal) is within bounds.
*/
static void PROGRESS_CoercePos(PROGRESS_INFO *infoPtr)
{
if(infoPtr->CurVal < infoPtr->MinVal)
infoPtr->CurVal = infoPtr->MinVal;
if(infoPtr->CurVal > infoPtr->MaxVal)
infoPtr->CurVal = infoPtr->MaxVal;
}
/***********************************************************************
* PROGRESS_SetFont
* Set new Font for progress bar
*/
static HFONT PROGRESS_SetFont (PROGRESS_INFO *infoPtr, HFONT hFont, BOOL bRedraw)
{
HFONT hOldFont = infoPtr->Font;
infoPtr->Font = hFont;
/* Since infoPtr->Font is not used, there is no need for repaint */
return hOldFont;
}
static DWORD PROGRESS_SetRange (PROGRESS_INFO *infoPtr, int low, int high)
{
DWORD res = MAKELONG(LOWORD(infoPtr->MinVal), LOWORD(infoPtr->MaxVal));
/* if nothing changes, simply return */
if(infoPtr->MinVal == low && infoPtr->MaxVal == high) return res;
infoPtr->MinVal = low;
infoPtr->MaxVal = high;
PROGRESS_CoercePos(infoPtr);
InvalidateRect(infoPtr->Self, NULL, TRUE);
return res;
}
/***********************************************************************
* ProgressWindowProc
*/
static LRESULT WINAPI ProgressWindowProc(HWND hwnd, UINT message,
WPARAM wParam, LPARAM lParam)
{
PROGRESS_INFO *infoPtr;
TRACE("hwnd=%p msg=%04x wparam=%x lParam=%lx\n", hwnd, message, wParam, lParam);
infoPtr = (PROGRESS_INFO *)GetWindowLongPtrW(hwnd, 0);
if (!infoPtr && message != WM_CREATE)
return DefWindowProcW( hwnd, message, wParam, lParam );
switch(message) {
case WM_CREATE:
{
DWORD dwExStyle = GetWindowLongW (hwnd, GWL_EXSTYLE);
dwExStyle &= ~(WS_EX_CLIENTEDGE | WS_EX_WINDOWEDGE);
dwExStyle |= WS_EX_STATICEDGE;
SetWindowLongW (hwnd, GWL_EXSTYLE, dwExStyle);
/* Force recalculation of a non-client area */
SetWindowPos(hwnd, 0, 0, 0, 0, 0,
SWP_FRAMECHANGED | SWP_NOSIZE | SWP_NOMOVE | SWP_NOZORDER | SWP_NOACTIVATE);
/* allocate memory for info struct */
infoPtr = (PROGRESS_INFO *)Alloc (sizeof(PROGRESS_INFO));
if (!infoPtr) return -1;
SetWindowLongPtrW (hwnd, 0, (DWORD_PTR)infoPtr);
/* initialize the info struct */
infoPtr->Self = hwnd;
infoPtr->MinVal = 0;
infoPtr->MaxVal = 100;
infoPtr->CurVal = 0;
infoPtr->Step = 10;
infoPtr->MarqueePos = 0;
infoPtr->Marquee = FALSE;
infoPtr->ColorBar = CLR_DEFAULT;
infoPtr->ColorBk = CLR_DEFAULT;
infoPtr->Font = 0;
TRACE("Progress Ctrl creation, hwnd=%p\n", hwnd);
return 0;
}
case WM_DESTROY:
TRACE("Progress Ctrl destruction, hwnd=%p\n", hwnd);
Free (infoPtr);
SetWindowLongPtrW(hwnd, 0, 0);
return 0;
case WM_GETFONT:
return (LRESULT)infoPtr->Font;
case WM_SETFONT:
return (LRESULT)PROGRESS_SetFont(infoPtr, (HFONT)wParam, (BOOL)lParam);
case WM_PAINT:
return PROGRESS_Paint (infoPtr, (HDC)wParam);
case WM_TIMER:
return PROGRESS_Timer (infoPtr, (INT)wParam);
case PBM_DELTAPOS:
{
INT oldVal;
oldVal = infoPtr->CurVal;
if(wParam != 0) {
infoPtr->CurVal += (INT)wParam;
PROGRESS_CoercePos (infoPtr);
TRACE("PBM_DELTAPOS: current pos changed from %d to %d\n", oldVal, infoPtr->CurVal);
PROGRESS_Invalidate( infoPtr, oldVal, infoPtr->CurVal );
}
return oldVal;
}
case PBM_SETPOS:
{
UINT oldVal;
oldVal = infoPtr->CurVal;
if(oldVal != wParam) {
infoPtr->CurVal = (INT)wParam;
PROGRESS_CoercePos(infoPtr);
TRACE("PBM_SETPOS: current pos changed from %d to %d\n", oldVal, infoPtr->CurVal);
PROGRESS_Invalidate( infoPtr, oldVal, infoPtr->CurVal );
}
return oldVal;
}
case PBM_SETRANGE:
return PROGRESS_SetRange (infoPtr, (int)LOWORD(lParam), (int)HIWORD(lParam));
case PBM_SETSTEP:
{
INT oldStep;
oldStep = infoPtr->Step;
infoPtr->Step = (INT)wParam;
return oldStep;
}
case PBM_STEPIT:
{
INT oldVal;
oldVal = infoPtr->CurVal;
infoPtr->CurVal += infoPtr->Step;
if(infoPtr->CurVal > infoPtr->MaxVal)
infoPtr->CurVal = infoPtr->MinVal;
if(oldVal != infoPtr->CurVal)
{
TRACE("PBM_STEPIT: current pos changed from %d to %d\n", oldVal, infoPtr->CurVal);
PROGRESS_Invalidate( infoPtr, oldVal, infoPtr->CurVal );
}
return oldVal;
}
case PBM_SETRANGE32:
return PROGRESS_SetRange (infoPtr, (int)wParam, (int)lParam);
case PBM_GETRANGE:
if (lParam) {
((PPBRANGE)lParam)->iLow = infoPtr->MinVal;
((PPBRANGE)lParam)->iHigh = infoPtr->MaxVal;
}
return wParam ? infoPtr->MinVal : infoPtr->MaxVal;
case PBM_GETPOS:
return infoPtr->CurVal;
case PBM_SETBARCOLOR:
infoPtr->ColorBar = (COLORREF)lParam;
InvalidateRect(hwnd, NULL, TRUE);
return 0;
case PBM_SETBKCOLOR:
infoPtr->ColorBk = (COLORREF)lParam;
InvalidateRect(hwnd, NULL, TRUE);
return 0;
case PBM_SETMARQUEE:
if(wParam != 0)
{
infoPtr->Marquee = TRUE;
SetTimer(infoPtr->Self, ID_MARQUEE_TIMER, (UINT)lParam, NULL);
}
else
{
infoPtr->Marquee = FALSE;
KillTimer(infoPtr->Self, ID_MARQUEE_TIMER);
}
return infoPtr->Marquee;
default:
if ((message >= WM_USER) && (message < WM_APP))
ERR("unknown msg %04x wp=%04x lp=%08lx\n", message, wParam, lParam );
return DefWindowProcW( hwnd, message, wParam, lParam );
}
}
/***********************************************************************
* PROGRESS_Register [Internal]
*
* Registers the progress bar window class.
*/
void PROGRESS_Register (void)
{
WNDCLASSW wndClass;
ZeroMemory (&wndClass, sizeof(wndClass));
wndClass.style = CS_GLOBALCLASS | CS_VREDRAW | CS_HREDRAW;
wndClass.lpfnWndProc = (WNDPROC)ProgressWindowProc;
wndClass.cbClsExtra = 0;
wndClass.cbWndExtra = sizeof (PROGRESS_INFO *);
wndClass.hCursor = LoadCursorW (0, (LPWSTR)IDC_ARROW);
wndClass.lpszClassName = PROGRESS_CLASSW;
RegisterClassW (&wndClass);
}
/***********************************************************************
* PROGRESS_Unregister [Internal]
*
* Unregisters the progress bar window class.
*/
void PROGRESS_Unregister (void)
{
UnregisterClassW (PROGRESS_CLASSW, NULL);
}
Reference in New Issue View Git Blame Copy Permalink