SlsToolTip.cxx

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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#include <view/SlsPageObjectLayouter.hxx>
#include <view/SlsToolTip.hxx>
#include <view/SlideSorterView.hxx>
#include <view/SlsLayouter.hxx>
#include <SlideSorter.hxx>
#include <Window.hxx>
#include <sdpage.hxx>
#include <sdresid.hxx>
#include <strings.hrc>
 
#include <osl/diagnose.h>
#include <vcl/settings.hxx>
#include <vcl/help.hxx>
 
namespace sd::slidesorter::view {
 
ToolTip::ToolTip (SlideSorter& rSlideSorter)
    : mrSlideSorter(rSlideSorter),
      mnHelpWindowHandle(nullptr),
      maShowTimer("sd::slidesorter::view::ToolTip maShowTimer"),
      maHiddenTimer("sd::slidesorter::view::ToolTip maHiddenTimer")
{
    maShowTimer.SetTimeout(HelpSettings::GetTipDelay());
    maShowTimer.SetInvokeHandler(LINK(this, ToolTip, DelayTrigger));
    maHiddenTimer.SetTimeout(HelpSettings::GetTipDelay());
}
 
ToolTip::~ToolTip()
{
    maShowTimer.Stop();
    maHiddenTimer.Stop();
    Hide();
}
 
void ToolTip::SetPage (const model::SharedPageDescriptor& rpDescriptor)
{
    if (mpDescriptor == rpDescriptor)
        return;
 
    maShowTimer.Stop();
    bool bWasVisible = Hide();
 
    if (bWasVisible)
    {
        maHiddenTimer.Start();
    }
 
    mpDescriptor = rpDescriptor;
 
    if (mpDescriptor)
    {
        SdPage* pPage = mpDescriptor->GetPage();
        OUString sHelpText;
        if (pPage != nullptr)
            sHelpText = pPage->GetName();
        else
        {
            OSL_ASSERT(mpDescriptor->GetPage() != nullptr);
        }
        if (sHelpText.isEmpty())
        {
            sHelpText = SdResId(STR_PAGE) +
                OUString::number(mpDescriptor->GetPageIndex()+1);
        }
 
        msCurrentHelpText = sHelpText;
        // show new tooltip immediately, if last one was recently hidden
        if(maHiddenTimer.IsActive())
            DoShow();
        else
            maShowTimer.Start();
    }
    else
    {
        msCurrentHelpText.clear();
    }
}
 
void ToolTip::DoShow()
{
    if (maShowTimer.IsActive())
    {
        // The delay timer is active.  Wait for it to trigger the showing of
        // the tool tip.
        return;
    }
 
    sd::Window *pWindow (mrSlideSorter.GetContentWindow().get());
    if (msCurrentHelpText.isEmpty() || !pWindow)
        return;
 
    ::tools::Rectangle aBox (
        mrSlideSorter.GetView().GetLayouter().GetPageObjectLayouter()->GetBoundingBox(
            mpDescriptor,
            PageObjectLayouter::Part::Preview,
            PageObjectLayouter::WindowCoordinateSystem));
 
    // Do not show the help text when the (lower edge of the ) preview
    // is not visible.  The tool tip itself may still be outside the
    // window.
    if (aBox.Bottom() >= pWindow->GetSizePixel().Height())
        return;
 
    vcl::Window* pParent (pWindow);
    while (pParent!=nullptr && pParent->GetParent()!=nullptr)
        pParent = pParent->GetParent();
    const Point aOffset (pWindow->GetWindowExtentsRelative(*pParent).TopLeft());
 
    // We do not know how high the tool tip will be but want its top
    // edge not its bottom to be at a specific position (a little below
    // the preview).  Therefore we use a little trick and place the tool
    // tip at the top of a rectangle that is placed below the preview.
    aBox.Move(aOffset.X(), aOffset.Y() + aBox.GetHeight() + 3);
    mnHelpWindowHandle = Help::ShowPopover(
        pWindow,
        aBox,
        msCurrentHelpText,
        QuickHelpFlags::Center | QuickHelpFlags::Top);
}
 
bool ToolTip::Hide()
{
    if (mnHelpWindowHandle)
    {
        sd::Window *pWindow (mrSlideSorter.GetContentWindow().get());
        Help::HidePopover(pWindow, mnHelpWindowHandle);
        mnHelpWindowHandle = nullptr;
        return true;
    }
    else
        return false;
}
 
IMPL_LINK_NOARG(ToolTip, DelayTrigger, Timer *, void)
{
    DoShow();
}
 
} // end of namespace ::sd::slidesorter::view
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */