swruler.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#ifndef INCLUDED_SW_SOURCE_UIBASE_INC_SWRULER_HXX
#define INCLUDED_SW_SOURCE_UIBASE_INC_SWRULER_HXX
 
#include <svx/ruler.hxx>
#include <vcl/timer.hxx>
#include <vcl/virdev.hxx>
 
class SwViewShell;
class View;
namespace vcl { class Window; }
class SwEditWin;
namespace tools { class JsonWriter; }
 
class SwCommentRuler final : public SvxRuler
{
public:
    SwCommentRuler (
        SwViewShell* pViewSh,
        vcl::Window* pParent,
        SwEditWin* pWin,
        SvxRulerSupportFlags nRulerFlags,
        SfxBindings& rBindings,
        WinBits nWinStyle);
    virtual ~SwCommentRuler () override;
    virtual void dispose() override;
 
    virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
    void CreateJsonNotification(tools::JsonWriter& rJsonWriter);
 
private:
    SwViewShell * mpViewShell;     //< Shell to check if there is any comments on doc and their visibility
    VclPtr<SwEditWin> mpSwWin;         //< Used to get SwView to change the SideBar visibility
    bool        mbIsHighlighted; //< If comment control is highlighted (mouse is over it)
    Timer       maFadeTimer;     //< Timer for high/'low'light fading
    int         mnFadeRate;      //< From 0 to 100. 0 means not highlighted.
    ScopedVclPtr<VirtualDevice> maVirDev;      //< VirtualDevice of this window. Just for convenience.
 
    void NotifyKit();
    virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
    virtual void MouseMove(const MouseEvent& rMEvt) override;
    virtual void Command( const CommandEvent& rCEvt ) override;
    virtual void Update() override;
 
    tools::Rectangle GetCommentControlRegion();
 
    void DrawCommentControl(vcl::RenderContext& rRenderContext);
 
    void UpdateCommentHelpText();
 
    Color GetFadedColor(const Color &rHighColor, const Color &rLowColor);
 
    DECL_LINK(FadeHandler, Timer *, void);
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */