sw/source/uibase/inc/swruler.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
  10 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_SWRULER_HXX
  11 #define INCLUDED_SW_SOURCE_UIBASE_INC_SWRULER_HXX
  12
  13 #include <svx/ruler.hxx>
  14 #include <vcl/timer.hxx>
  15 #include <vcl/virdev.hxx>
  16
  17 class SwViewShell;
  18 class View;
  19 namespace vcl { class Window; }
  20 class SwEditWin;
  21 namespace tools { class JsonWriter; }
  22
  23 /**
  24  * An horizontal ruler with a control for comment panel visibility for Writer.
  25  *
  26  * The comment control only appears when the document has comments already.
  27  */
  28 class SwCommentRuler final : public SvxRuler
  29 {
  30 public:
  31     SwCommentRuler (
  32         SwViewShell* pViewSh,
  33         vcl::Window* pParent,
  34         SwEditWin* pWin,
  35         SvxRulerSupportFlags nRulerFlags,
  36         SfxBindings& rBindings,
  37         WinBits nWinStyle);
  38     virtual ~SwCommentRuler () override;
  39     virtual void dispose() override;
  40
  41     /**
  42      * Paint the ruler.
  43      * \param rRect ignored
  44      */
  45     virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
  46     void CreateJsonNotification(tools::JsonWriter& rJsonWriter);
  47
  48 private:
  49     SwViewShell * mpViewShell;     //< Shell to check if there is any comments on doc and their visibility
  50     VclPtr<SwEditWin> mpSwWin;         //< Used to get SwView to change the SideBar visibility
  51     bool        mbIsHighlighted; //< If comment control is highlighted (mouse is over it)
  52     Timer       maFadeTimer;     //< Timer for high/'low'light fading
  53     int         mnFadeRate;      //< From 0 to 100. 0 means not highlighted.
  54     ScopedVclPtr<VirtualDevice> maVirDev;      //< VirtualDevice of this window. Just for convenience.
  55
  56     void NotifyKit();
  57     /**
  58      * Callback function to handle a mouse button down event.
  59      *
  60      * When on comment control, it toggles the comment panel visibility.
  61      */
  62     virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
  63     /**
  64      * Callback function to handle a mouse move event.
  65      *
  66      * When on comment control, it let the control responsive by highlighting.
  67      */
  68     virtual void MouseMove(const MouseEvent& rMEvt) override;
  69     /**
  70      * Callback function to handle a context menu call (mouse right button click).
  71      *
  72      * When on comment control, it does not do anything.
  73      */
  74     virtual void Command( const CommandEvent& rCEvt ) override;
  75     /**
  76      * Update the view.
  77      *
  78      * Update the ruler appearance according to the document view and
  79      * current cursor position.
  80      */
  81     virtual void Update() override;
  82
  83     /**
  84      * Get the rectangle area that should be used to draw the comment control.
  85      *
  86      * It is horizontally aligned to the SideBar panel.
  87      * \return The area where the comment control is.
  88      */
  89     tools::Rectangle GetCommentControlRegion();
  90
  91     /**
  92      * Paint the comment control on VirtualDevice.
  93      */
  94     void DrawCommentControl(vcl::RenderContext& rRenderContext);
  95
  96     /**
  97      * Update the tooltip text.
  98      */
  99     void UpdateCommentHelpText();
 100
 101     /**
 102      * Get the proper color between two options, according to current status.
 103      *
 104      * The return color can be one of the given colors, or a merged one.
 105      * It depends on highlight fading status.
 106      *
 107      * \param rHighColor color used to highlight status
 108      * \param rLowColor color used to normal status
 109      * \return The proper color to used in moment
 110      */
 111     Color GetFadedColor(const Color &rHighColor, const Color &rLowColor);
 112
 113     /// Fade timer callback.
 114     DECL_LINK(FadeHandler, Timer *, void);
 115 };
 116
 117 #endif
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */