windows/scroll.c

   1 /*
   2  * Scroll windows and DCs
   3  *
   4  * Copyright  David W. Metcalfe, 1993
   5  *            Alex Korobka       1995,1996
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include <stdarg.h>
  23 #include <stdlib.h>
  24
  25 #include "windef.h"
  26 #include "winbase.h"
  27 #include "wingdi.h"
  28 #include "wine/winuser16.h"
  29 #include "winuser.h"
  30 #include "user.h"
  31 #include "win.h"
  32 #include "wine/debug.h"
  33
  34 WINE_DEFAULT_DEBUG_CHANNEL(scroll);
  35
  36 /*************************************************************************
  37  *             fix_caret
  38  */
  39 static HWND fix_caret(HWND hWnd, LPRECT lprc, UINT flags)
  40 {
  41     GUITHREADINFO info;
  42
  43     if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
  44     if (!info.hwndCaret) return 0;
  45     if (info.hwndCaret == hWnd ||
  46         ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret)))
  47     {
  48         POINT pt;
  49         pt.x = info.rcCaret.left;
  50         pt.y = info.rcCaret.top;
  51         MapWindowPoints( info.hwndCaret, hWnd, (LPPOINT)&info.rcCaret, 2 );
  52         if( IntersectRect(lprc, lprc, &info.rcCaret) )
  53         {
  54             HideCaret(0);
  55             lprc->left = pt.x;
  56             lprc->top = pt.y;
  57             return info.hwndCaret;
  58         }
  59     }
  60     return 0;
  61 }
  62
  63 /*************************************************************************
  64  *              scroll_window
  65  *
  66  * Note: contrary to what the doc says, pixels that are scrolled from the
  67  *      outside of clipRect to the inside are NOT painted.
  68  *
  69  * Parameter are the same as in ScrollWindowEx, with the additional
  70  * requirement that rect and clipRect are _valid_ pointers, to
  71  * rectangles _within_ the client are. Moreover, there is something
  72  * to scroll.
  73  */
  74 static INT scroll_window( HWND hwnd, INT dx, INT dy, const RECT *rect,
  75                           const RECT *clipRect, HRGN hrgnUpdate, LPRECT rcUpdate, UINT flags )
  76 {
  77     INT   retVal;
  78     BOOL  bOwnRgn = TRUE;
  79     BOOL  bUpdate = (rcUpdate || hrgnUpdate || flags & (SW_INVALIDATE | SW_ERASE));
  80     HRGN  hrgnTemp;
  81     HDC   hDC;
  82     RECT  rc, cliprc;
  83
  84     TRACE( "%p, %d,%d hrgnUpdate=%p rcUpdate = %p %s %04x\n",
  85            hwnd, dx, dy, hrgnUpdate, rcUpdate, wine_dbgstr_rect(rect), flags );
  86     TRACE( "clipRect = %s\n", wine_dbgstr_rect(clipRect));
  87
  88     GetClientRect(hwnd, &rc);
  89     if (rect) IntersectRect(&rc, &rc, rect);
  90
  91     if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
  92     else cliprc = rc;
  93
  94     if( hrgnUpdate ) bOwnRgn = FALSE;
  95     else if( bUpdate ) hrgnUpdate = CreateRectRgn( 0, 0, 0, 0 );
  96
  97     hDC = GetDCEx( hwnd, 0, DCX_CACHE | DCX_USESTYLE );
  98     if (hDC)
  99     {
 100         ScrollDC( hDC, dx, dy, &rc, &cliprc, hrgnUpdate, rcUpdate );
 101
 102         ReleaseDC( hwnd, hDC );
 103
 104         if (!bUpdate)
 105             RedrawWindow( hwnd, NULL, hrgnUpdate, RDW_INVALIDATE | RDW_ERASE );
 106     }
 107
 108     /* Take into account the fact that some damage may have occurred during the scroll */
 109     hrgnTemp = CreateRectRgn( 0, 0, 0, 0 );
 110     retVal = GetUpdateRgn( hwnd, hrgnTemp, FALSE );
 111     if (retVal != NULLREGION)
 112     {
 113         HRGN hrgnClip = CreateRectRgnIndirect(&cliprc);
 114         OffsetRgn( hrgnTemp, dx, dy );
 115         CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
 116         RedrawWindow( hwnd, NULL, hrgnTemp, RDW_INVALIDATE | RDW_ERASE );
 117         DeleteObject( hrgnClip );
 118     }
 119     DeleteObject( hrgnTemp );
 120
 121     if( flags & SW_SCROLLCHILDREN )
 122     {
 123         HWND *list = WIN_ListChildren( hwnd );
 124         if (list)
 125         {
 126             int i;
 127             RECT r, dummy;
 128             for (i = 0; list[i]; i++)
 129             {
 130                 GetWindowRect( list[i], &r );
 131                 MapWindowPoints( 0, hwnd, (POINT *)&r, 2 );
 132                 if (!rect || IntersectRect(&dummy, &r, &rc))
 133                     SetWindowPos( list[i], 0, r.left + dx, r.top  + dy, 0, 0,
 134                                   SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
 135                                   SWP_NOREDRAW | SWP_DEFERERASE );
 136             }
 137             HeapFree( GetProcessHeap(), 0, list );
 138         }
 139     }
 140
 141     if( flags & (SW_INVALIDATE | SW_ERASE) )
 142         RedrawWindow( hwnd, NULL, hrgnUpdate, RDW_INVALIDATE | RDW_ERASE |
 143                       ((flags & SW_ERASE) ? RDW_ERASENOW : 0) |
 144                       ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
 145
 146     if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
 147
 148     return retVal;
 149 }
 150
 151 /*************************************************************************
 152  *              ScrollWindow (USER32.@)
 153  *
 154  */
 155 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
 156                               const RECT *rect, const RECT *clipRect )
 157 {
 158     return
 159         (ERROR != ScrollWindowEx( hwnd, dx, dy, rect, clipRect, 0, NULL,
 160                                     (rect ? 0 : SW_SCROLLCHILDREN) |
 161                                     SW_INVALIDATE ));
 162 }
 163
 164 /*************************************************************************
 165  *              ScrollDC (USER32.@)
 166  *
 167  * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is wrong)
 168  * hrgnUpdate is returned in device coordinates with rcUpdate in logical coordinates.
 169  */
 170 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
 171                       const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
 172
 173 {
 174     RECT rSrc, rClipped_src, rClip, rDst, offset;
 175
 176     TRACE( "%p %d,%d hrgnUpdate=%p lprcUpdate = %p\n", hdc, dx, dy, hrgnUpdate, lprcUpdate );
 177     if (lprcClip) TRACE( "lprcClip = %s\n", wine_dbgstr_rect(lprcClip));
 178     if (lprcScroll) TRACE( "lprcScroll = %s\n", wine_dbgstr_rect(lprcScroll));
 179
 180     if (USER_Driver.pScrollDC)
 181         return USER_Driver.pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );
 182
 183     /* compute device clipping region (in device coordinates) */
 184     if (lprcScroll) rSrc = *lprcScroll;
 185     else GetClipBox( hdc, &rSrc );
 186     LPtoDP(hdc, (LPPOINT)&rSrc, 2);
 187
 188     if (lprcClip) rClip = *lprcClip;
 189     else GetClipBox( hdc, &rClip );
 190     LPtoDP(hdc, (LPPOINT)&rClip, 2);
 191
 192     IntersectRect( &rClipped_src, &rSrc, &rClip );
 193     TRACE("rSrc %s rClip %s clipped rSrc %s\n", wine_dbgstr_rect(&rSrc),
 194           wine_dbgstr_rect(&rClip), wine_dbgstr_rect(&rClipped_src));
 195
 196     rDst = rClipped_src;
 197     SetRect(&offset, 0, 0, dx, dy);
 198     LPtoDP(hdc, (LPPOINT)&offset, 2);
 199     OffsetRect( &rDst, offset.right - offset.left,  offset.bottom - offset.top );
 200     TRACE("rDst before clipping %s\n", wine_dbgstr_rect(&rDst));
 201     IntersectRect( &rDst, &rDst, &rClip );
 202     TRACE("rDst after clipping %s\n", wine_dbgstr_rect(&rDst));
 203
 204     if (!IsRectEmpty(&rDst))
 205     {
 206         /* copy bits */
 207         RECT rDst_lp = rDst, rSrc_lp = rDst;
 208
 209         OffsetRect( &rSrc_lp, offset.left - offset.right, offset.top - offset.bottom );
 210         DPtoLP(hdc, (LPPOINT)&rDst_lp, 2);
 211         DPtoLP(hdc, (LPPOINT)&rSrc_lp, 2);
 212
 213         if (!BitBlt( hdc, rDst_lp.left, rDst_lp.top,
 214                      rDst_lp.right - rDst_lp.left, rDst_lp.bottom - rDst_lp.top,
 215                      hdc, rSrc_lp.left, rSrc_lp.top, SRCCOPY))
 216             return FALSE;
 217     }
 218
 219     /* compute update areas.  This is the clipped source or'ed with the unclipped source translated minus the
 220      clipped src translated (rDst) all clipped to rClip */
 221
 222     if (hrgnUpdate || lprcUpdate)
 223     {
 224         HRGN hrgn = hrgnUpdate, hrgn2;
 225
 226         if (hrgn) SetRectRgn( hrgn, rClipped_src.left, rClipped_src.top, rClipped_src.right, rClipped_src.bottom );
 227         else hrgn = CreateRectRgn( rClipped_src.left, rClipped_src.top, rClipped_src.right, rClipped_src.bottom );
 228
 229         hrgn2 = CreateRectRgnIndirect( &rSrc );
 230         OffsetRgn(hrgn2, offset.right - offset.left,  offset.bottom - offset.top );
 231         CombineRgn(hrgn, hrgn, hrgn2, RGN_OR);
 232
 233         SetRectRgn( hrgn2, rDst.left, rDst.top, rDst.right, rDst.bottom );
 234         CombineRgn( hrgn, hrgn, hrgn2, RGN_DIFF );
 235
 236         SetRectRgn( hrgn2, rClip.left, rClip.top, rClip.right, rClip.bottom );
 237         CombineRgn( hrgn, hrgn, hrgn2, RGN_AND );
 238
 239         if( lprcUpdate )
 240         {
 241             GetRgnBox( hrgn, lprcUpdate );
 242
 243             /* Put the lprcUpdate in logical coordinate */
 244             DPtoLP( hdc, (LPPOINT)lprcUpdate, 2 );
 245             TRACE("returning lprcUpdate %s\n", wine_dbgstr_rect(lprcUpdate));
 246         }
 247         if (!hrgnUpdate) DeleteObject( hrgn );
 248         DeleteObject( hrgn2 );
 249     }
 250     return TRUE;
 251 }
 252
 253
 254 /*************************************************************************
 255  *              ScrollWindowEx (USER32.@)
 256  *
 257  * NOTE: Use this function instead of ScrollWindow32
 258  */
 259 INT WINAPI ScrollWindowEx( HWND hwnd, INT dx, INT dy,
 260                                const RECT *rect, const RECT *clipRect,
 261                                HRGN hrgnUpdate, LPRECT rcUpdate,
 262                                UINT flags )
 263 {
 264     RECT rc, cliprc;
 265     INT result;
 266
 267     if (!WIN_IsWindowDrawable( hwnd, TRUE )) return ERROR;
 268     hwnd = WIN_GetFullHandle( hwnd );
 269
 270     GetClientRect(hwnd, &rc);
 271     if (rect) IntersectRect(&rc, &rc, rect);
 272
 273     if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
 274     else cliprc = rc;
 275
 276     if (!IsRectEmpty(&cliprc) && (dx || dy))
 277     {
 278         RECT caretrc = rc;
 279         HWND hwndCaret = fix_caret(hwnd, &caretrc, flags);
 280
 281         result = scroll_window( hwnd, dx, dy, rect, clipRect,
 282                 hrgnUpdate, rcUpdate, flags );
 283
 284         if( hwndCaret )
 285         {
 286             SetCaretPos( caretrc.left + dx, caretrc.top + dy );
 287             ShowCaret(hwndCaret);
 288         }
 289     }
 290     else
 291         result = NULLREGION;
 292
 293     return result;
 294 }