Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef _SV_SCRBAR_HXX
      21             : #define _SV_SCRBAR_HXX
      22             : 
      23             : #include <tools/solar.h>
      24             : #include <vcl/dllapi.h>
      25             : #include <vcl/ctrl.hxx>
      26             : 
      27             : class AutoTimer;
      28             : 
      29             : // -------------------
      30             : // - ScrollBar-Types -
      31             : // -------------------
      32             : 
      33             : enum ScrollType { SCROLL_DONTKNOW, SCROLL_LINEUP, SCROLL_LINEDOWN,
      34             :                   SCROLL_PAGEUP, SCROLL_PAGEDOWN, SCROLL_DRAG, SCROLL_SET };
      35             : 
      36             : // -------------
      37             : // - ScrollBar -
      38             : // -------------
      39             : struct ImplScrollBarData;
      40             : 
      41             : class VCL_DLLPUBLIC ScrollBar : public Control
      42             : {
      43             : private:
      44             :     Rectangle       maBtn1Rect;
      45             :     Rectangle       maBtn2Rect;
      46             :     Rectangle       maPage1Rect;
      47             :     Rectangle       maPage2Rect;
      48             :     Rectangle       maThumbRect;
      49             :     ImplScrollBarData* mpData;
      50             :     long            mnStartPos;
      51             :     long            mnMouseOff;
      52             :     long            mnThumbPixRange;
      53             :     long            mnThumbPixPos;
      54             :     long            mnThumbPixSize;
      55             :     long            mnMinRange;
      56             :     long            mnMaxRange;
      57             :     long            mnThumbPos;
      58             :     long            mnVisibleSize;
      59             :     long            mnLineSize;
      60             :     long            mnPageSize;
      61             :     long            mnDelta;
      62             :     sal_uInt16          mnDragDraw;
      63             :     sal_uInt16          mnStateFlags;
      64             :     ScrollType      meScrollType;
      65             :     ScrollType      meDDScrollType;
      66             :     sal_Bool            mbCalcSize;
      67             :     sal_Bool            mbFullDrag;
      68             :     Link            maScrollHdl;
      69             :     Link            maEndScrollHdl;
      70             : 
      71             :     SAL_DLLPRIVATE Rectangle*   ImplFindPartRect( const Point& rPt );
      72             :     using Window::ImplInit;
      73             :     SAL_DLLPRIVATE void         ImplInit( Window* pParent, WinBits nStyle );
      74             :     SAL_DLLPRIVATE void         ImplInitStyle( WinBits nStyle );
      75             :     SAL_DLLPRIVATE void         ImplLoadRes( const ResId& rResId );
      76             :     SAL_DLLPRIVATE void         ImplUpdateRects( sal_Bool bUpdate = sal_True );
      77             :     SAL_DLLPRIVATE long         ImplCalcThumbPos( long nPixPos );
      78             :     SAL_DLLPRIVATE long         ImplCalcThumbPosPix( long nPos );
      79             :     SAL_DLLPRIVATE void         ImplCalc( sal_Bool bUpdate = sal_True );
      80             :     SAL_DLLPRIVATE void         ImplDraw( sal_uInt16 nDrawFlags, OutputDevice* pOutDev  );
      81             :     using Window::ImplScroll;
      82             :     SAL_DLLPRIVATE long         ImplScroll( long nNewPos, sal_Bool bCallEndScroll );
      83             :     SAL_DLLPRIVATE long         ImplDoAction( sal_Bool bCallEndScroll );
      84             :     SAL_DLLPRIVATE void         ImplDoMouseAction( const Point& rPos, sal_Bool bCallAction = sal_True );
      85             :     SAL_DLLPRIVATE void         ImplInvert();
      86             :     SAL_DLLPRIVATE sal_Bool     ImplDrawNative( sal_uInt16 nDrawFlags );
      87             :     SAL_DLLPRIVATE void         ImplDragThumb( const Point& rMousePos );
      88             :     SAL_DLLPRIVATE Size         getCurrentCalcSize() const;
      89             :     DECL_DLLPRIVATE_LINK(       ImplTimerHdl, Timer* );
      90             :     DECL_DLLPRIVATE_LINK(       ImplAutoTimerHdl, void* );
      91             : 
      92             : public:
      93             :                     ScrollBar( Window* pParent, WinBits nStyle = WB_VERT );
      94             :                     ScrollBar( Window* pParent, const ResId& rResId );
      95             :                     ~ScrollBar();
      96             : 
      97             :     virtual void    MouseButtonDown( const MouseEvent& rMEvt );
      98             :     virtual void    Tracking( const TrackingEvent& rTEvt );
      99             :     virtual void    KeyInput( const KeyEvent& rKEvt );
     100             :     virtual void    Paint( const Rectangle& rRect );
     101             :     virtual void    Draw( OutputDevice* pDev, const Point& rPos, const Size& rSize, sal_uLong nFlags );
     102             :     virtual void    Resize();
     103             :     virtual void    StateChanged( StateChangedType nType );
     104             :     virtual void    DataChanged( const DataChangedEvent& rDCEvt );
     105             :     virtual long    PreNotify( NotifyEvent& rNEvt );
     106             :     virtual void    GetFocus();
     107             :     virtual void    LoseFocus();
     108             : 
     109             :     using Window::Scroll;
     110             :     virtual void    Scroll();
     111             :     virtual void    EndScroll();
     112             : 
     113             :     long            DoScroll( long nNewPos );
     114             :     long            DoScrollAction( ScrollType eScrollType );
     115             : 
     116         494 :     void            EnableDrag( sal_Bool bEnable = sal_True )
     117         494 :                         { mbFullDrag = bEnable; }
     118             :     sal_Bool            IsDragEnabled() const { return mbFullDrag; }
     119             : 
     120             :     void            SetRangeMin( long nNewRange );
     121        1688 :     long            GetRangeMin() const { return mnMinRange; }
     122             :     void            SetRangeMax( long nNewRange );
     123        1688 :     long            GetRangeMax() const { return mnMaxRange; }
     124             :     void            SetRange( const Range& rRange );
     125        1688 :     Range           GetRange() const { return Range( GetRangeMin(), GetRangeMax() ); }
     126             :     void            SetThumbPos( long nThumbPos );
     127           0 :     long            GetThumbPos() const { return mnThumbPos; }
     128        2778 :     void            SetLineSize( long nNewSize ) { mnLineSize = nNewSize; }
     129           0 :     long            GetLineSize() const { return mnLineSize; }
     130        2778 :     void            SetPageSize( long nNewSize ) { mnPageSize = nNewSize; }
     131           0 :     long            GetPageSize() const { return mnPageSize; }
     132             :     void            SetVisibleSize( long nNewSize );
     133        4420 :     long            GetVisibleSize() const { return mnVisibleSize; }
     134             : 
     135           0 :     long            GetDelta() const { return mnDelta; }
     136           0 :     ScrollType      GetType() const { return meScrollType; }
     137             : 
     138         502 :     void            SetScrollHdl( const Link& rLink ) { maScrollHdl = rLink; }
     139             :     const Link&     GetScrollHdl() const { return maScrollHdl;    }
     140         480 :     void            SetEndScrollHdl( const Link& rLink ) { maEndScrollHdl = rLink; }
     141           0 :     const Link&     GetEndScrollHdl() const { return maEndScrollHdl; }
     142             : 
     143             :     virtual Size    GetOptimalSize(WindowSizeType eType) const;
     144             : };
     145             : 
     146             : // ----------------
     147             : // - ScrollBarBox -
     148             : // ----------------
     149             : 
     150         142 : class VCL_DLLPUBLIC ScrollBarBox : public Window
     151             : {
     152             : private:
     153             :     using Window::ImplInit;
     154             :     SAL_DLLPRIVATE void ImplInit( Window* pParent, WinBits nStyle );
     155             :     SAL_DLLPRIVATE void ImplInitSettings();
     156             : 
     157             : public:
     158             :                     ScrollBarBox( Window* pParent, WinBits nStyle = 0 );
     159             : 
     160             :     virtual void    StateChanged( StateChangedType nType );
     161             :     virtual void    DataChanged( const DataChangedEvent& rDCEvt );
     162             : };
     163             : 
     164             : #endif // _SV_SCRBAR_HXX
     165             : 
     166             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */