sdext/source/presenter/PresenterScrollBar.hxx

   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 INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERSCROLLBAR_HXX
  21 #define INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERSCROLLBAR_HXX
  22
  23 #include "PresenterBitmapContainer.hxx"
  24 #include <com/sun/star/awt/XWindow.hpp>
  25 #include <com/sun/star/drawing/XPresenterHelper.hpp>
  26 #include <com/sun/star/rendering/XCanvas.hpp>
  27 #include <com/sun/star/uno/XComponentContext.hpp>
  28 #include <cppuhelper/basemutex.hxx>
  29 #include <cppuhelper/compbase.hxx>
  30
  31 #include <functional>
  32 #include <memory>
  33
  34 namespace sdext::presenter {
  35
  36 class PresenterCanvasHelper;
  37 class PresenterPaintManager;
  38
  39 typedef ::cppu::WeakComponentImplHelper <
  40     css::awt::XWindowListener,
  41     css::awt::XPaintListener,
  42     css::awt::XMouseListener,
  43     css::awt::XMouseMotionListener
  44 > PresenterScrollBarInterfaceBase;
  45
  46 /** Base class of horizontal and vertical scroll bars.
  47 */
  48 class PresenterScrollBar
  49     : private ::cppu::BaseMutex,
  50       public PresenterScrollBarInterfaceBase
  51 {
  52 public:
  53     virtual ~PresenterScrollBar() override;
  54     PresenterScrollBar(const PresenterScrollBar&) = delete;
  55     PresenterScrollBar& operator=(const PresenterScrollBar&) = delete;
  56
  57     virtual void SAL_CALL disposing() override;
  58
  59     css::uno::Reference<css::uno::XComponentContext> const&
  60         GetComponentContext() const { return mxComponentContext; }
  61
  62     void SetVisible (const bool bIsVisible);
  63
  64     /** Set the bounding box of the scroll bar.
  65     */
  66     void SetPosSize (const css::geometry::RealRectangle2D& rBox);
  67
  68     /** Set the position of the movable thumb.
  69         @param nPosition
  70             A value between 0 and the last value given to SetTotalSize()
  71             minus the last value given to SetThumbSize().
  72     */
  73     void SetThumbPosition (
  74         double nPosition,
  75         const bool bAsynchronousRepaint);
  76
  77     double GetThumbPosition() const { return mnThumbPosition;}
  78
  79     /** Set the upper border of the slider range.
  80     */
  81     void SetTotalSize (const double nTotalSize);
  82
  83     /** Set the size of the movable thumb.
  84         @param nThumbSize
  85             A value not larger than the last value given to SetTotalSize().
  86     */
  87     void SetThumbSize (const double nThumbSize);
  88     double GetThumbSize() const { return mnThumbSize;}
  89
  90     void SetLineHeight (const double nLineHeight);
  91     double GetLineHeight() const { return mnLineHeight;}
  92
  93     /** Set the canvas that is used for painting the scroll bar.
  94     */
  95     void SetCanvas (const css::uno::Reference<css::rendering::XCanvas>& rxCanvas);
  96
  97     void SetBackground (const SharedBitmapDescriptor& rpBackgroundBitmap);
  98
  99     /** Call this after changing total size or thumb position or size to
 100         move the thumb to a valid position.
 101     */
 102     void CheckValues();
 103
 104     /** On some occasions it is necessary to trigger the painting of a
 105         scrollbar from the outside.
 106     */
 107     void Paint (
 108         const css::awt::Rectangle& rUpdateBox);
 109
 110     virtual sal_Int32 GetSize() const = 0;
 111
 112     // XWindowListener
 113
 114     virtual void SAL_CALL windowResized (const css::awt::WindowEvent& rEvent) override;
 115
 116     virtual void SAL_CALL windowMoved (const css::awt::WindowEvent& rEvent) override;
 117
 118     virtual void SAL_CALL windowShown (const css::lang::EventObject& rEvent) override;
 119
 120     virtual void SAL_CALL windowHidden (const css::lang::EventObject& rEvent) override;
 121
 122     // XPaintListener
 123
 124     virtual void SAL_CALL windowPaint (const css::awt::PaintEvent& rEvent) override;
 125
 126     // XMouseListener
 127
 128     virtual void SAL_CALL mousePressed (const css::awt::MouseEvent& rEvent) override;
 129
 130     virtual void SAL_CALL mouseReleased (const css::awt::MouseEvent& rEvent) override;
 131
 132     virtual void SAL_CALL mouseEntered (const css::awt::MouseEvent& rEvent) override;
 133
 134     virtual void SAL_CALL mouseExited (const css::awt::MouseEvent& rEvent) override;
 135
 136     // XMouseMotionListener
 137
 138     virtual void SAL_CALL mouseMoved (const css::awt::MouseEvent& rEvent) override;
 139
 140     virtual void SAL_CALL mouseDragged (const css::awt::MouseEvent& rEvent) override;
 141
 142     // lang::XEventListener
 143     virtual void SAL_CALL disposing (const css::lang::EventObject& rEvent) override;
 144
 145     enum Area { Total, Pager, Thumb, PagerUp, PagerDown, PrevButton, NextButton, None,
 146                 AreaCount = None };
 147
 148 protected:
 149     css::uno::Reference<css::uno::XComponentContext> mxComponentContext;
 150     css::uno::Reference<css::awt::XWindow> mxWindow;
 151     css::uno::Reference<css::rendering::XCanvas> mxCanvas;
 152     css::uno::Reference<css::drawing::XPresenterHelper> mxPresenterHelper;
 153     std::shared_ptr<PresenterPaintManager> mpPaintManager;
 154     double mnThumbPosition;
 155     double mnTotalSize;
 156     double mnThumbSize;
 157     double mnLineHeight;
 158     css::geometry::RealPoint2D maDragAnchor;
 159     ::std::function<void (double)> maThumbMotionListener;
 160     Area meButtonDownArea;
 161     Area meMouseMoveArea;
 162     css::geometry::RealRectangle2D maBox[AreaCount];
 163     bool mbIsNotificationActive;
 164     static std::weak_ptr<PresenterBitmapContainer> mpSharedBitmaps;
 165     std::shared_ptr<PresenterBitmapContainer> mpBitmaps;
 166     SharedBitmapDescriptor mpPrevButtonDescriptor;
 167     SharedBitmapDescriptor mpNextButtonDescriptor;
 168     SharedBitmapDescriptor mpPagerStartDescriptor;
 169     SharedBitmapDescriptor mpPagerCenterDescriptor;
 170     SharedBitmapDescriptor mpPagerEndDescriptor;
 171     SharedBitmapDescriptor mpThumbStartDescriptor;
 172     SharedBitmapDescriptor mpThumbCenterDescriptor;
 173     SharedBitmapDescriptor mpThumbEndDescriptor;
 174     bool maEnabledState[AreaCount];
 175
 176     css::geometry::RealRectangle2D const & GetRectangle (const Area eArea) const;
 177     virtual double GetDragDistance (const sal_Int32 nX, const sal_Int32 nY) const = 0;
 178     virtual void UpdateDragAnchor (const double nDragDistance) = 0;
 179     virtual double GetMinor (const double nX, const double nY) const = 0;
 180     virtual void UpdateBorders() = 0;
 181     virtual void UpdateBitmaps() = 0;
 182     virtual void PaintComposite(
 183         const css::awt::Rectangle& rRepaintBox,
 184         const Area eArea,
 185         const SharedBitmapDescriptor& rpStartBitmaps,
 186         const SharedBitmapDescriptor& rpCenterBitmaps,
 187         const SharedBitmapDescriptor& rpEndBitmaps) = 0;
 188
 189     PresenterScrollBar (
 190         const css::uno::Reference<css::uno::XComponentContext>& rxComponentContext,
 191         const css::uno::Reference<css::awt::XWindow>& rxParentWindow,
 192         const std::shared_ptr<PresenterPaintManager>& rpPaintManager,
 193         const ::std::function<void (double)>& rThumbMotionListener);
 194
 195     void Repaint (
 196         const css::geometry::RealRectangle2D& rBox,
 197         const bool bAsynchronous);
 198     void PaintBackground (
 199         const css::awt::Rectangle& rRepaintBox);
 200     void PaintBitmap(
 201         const css::awt::Rectangle& rRepaintBox,
 202         const Area eArea,
 203         const SharedBitmapDescriptor& rpBitmaps);
 204     void UpdateWidthOrHeight (sal_Int32& rSize,
 205         const SharedBitmapDescriptor& rpDescriptor);
 206     css::uno::Reference<css::rendering::XBitmap> GetBitmap (
 207         const Area eArea,
 208         const SharedBitmapDescriptor& rpBitmaps) const;
 209     PresenterBitmapContainer::BitmapDescriptor::Mode GetBitmapMode (
 210         const Area eArea) const;
 211     bool IsDisabled (const Area eArea) const;
 212     double ValidateThumbPosition (double nPosition);
 213
 214 private:
 215     class MousePressRepeater;
 216     std::shared_ptr<MousePressRepeater> mpMousePressRepeater;
 217     SharedBitmapDescriptor mpBackgroundBitmap;
 218     std::unique_ptr<PresenterCanvasHelper> mpCanvasHelper;
 219
 220     Area GetArea (const double nX, const double nY) const;
 221 };
 222
 223 /** A vertical scroll bar.
 224 */
 225 class PresenterVerticalScrollBar : public PresenterScrollBar
 226 {
 227 public:
 228     PresenterVerticalScrollBar (
 229         const css::uno::Reference<css::uno::XComponentContext>& rxComponentContext,
 230         const css::uno::Reference<css::awt::XWindow>& rxParentWindow,
 231         const std::shared_ptr<PresenterPaintManager>& rpPaintManager,
 232         const ::std::function<void (double)>& rThumbMotionListener);
 233     virtual ~PresenterVerticalScrollBar() override;
 234     virtual sal_Int32 GetSize() const override;
 235
 236 protected:
 237     virtual double GetDragDistance (const sal_Int32 nX, const sal_Int32 nY) const override;
 238     virtual void UpdateDragAnchor (const double nDragDistance) override;
 239     virtual double GetMinor (const double nX, const double nY) const override;
 240     virtual void UpdateBorders() override;
 241     virtual void UpdateBitmaps() override;
 242     virtual void PaintComposite(
 243         const css::awt::Rectangle& rRepaintBox,
 244         const Area eArea,
 245         const SharedBitmapDescriptor& rpStartBitmaps,
 246         const SharedBitmapDescriptor& rpCenterBitmaps,
 247         const SharedBitmapDescriptor& rpEndBitmaps) override;
 248
 249 private:
 250     sal_Int32 mnScrollBarWidth;
 251 };
 252
 253 } // end of namespace ::sdext::presenter
 254
 255 #endif
 256
 257 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */