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