sd/source/ui/slidesorter/inc/view/SlsToolTip.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_SD_SOURCE_UI_SLIDESORTER_INC_VIEW_SLSTOOLTIP_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_VIEW_SLSTOOLTIP_HXX
  22
  23 #include "SlideSorter.hxx"
  24 #include "model/SlsSharedPageDescriptor.hxx"
  25
  26 namespace sd { namespace slidesorter { namespace view {
  27
  28 /** Manage the display of tool tips.  The tool tip text changes when the
  29     mouse is moved from slide to slide or from button to button.
  30     After the mouse enters a slide the first display of the tool tip is
  31     delayed for a short time in order to not draw attention from the slide
  32     or its button bar.
  33 */
  34 class ToolTip
  35 {
  36 public:
  37     ToolTip (SlideSorter& rSlideSorter);
  38     ~ToolTip();
  39
  40     /** Set a new page.  This modifies the default help text.  After a page
  41         change a timer is started to delay the display of the tool tip for
  42         the new page.
  43         @param rpPage
  44             When this is empty then the tool tip is hidden.
  45     */
  46     void SetPage (const model::SharedPageDescriptor& rpPage);
  47
  48     /** Hide the tool tip.
  49         @return
  50             Returns whether the tool tip was visible at the time this method
  51             was called.
  52     */
  53     bool Hide();
  54
  55 private:
  56     SlideSorter& mrSlideSorter;
  57     model::SharedPageDescriptor mpDescriptor;
  58     OUString msCurrentHelpText;
  59     sal_uLong mnHelpWindowHandle;
  60     Timer maShowTimer;
  61     Timer maHiddenTimer;
  62
  63     /** Request to show the tool tip.
  64         @param bForce
  65             When <TRUE/> then the tool tip is show right away.  Otherwise it
  66             is shown after a short delay.
  67     */
  68     void Show (const bool bForce);
  69     void DoShow();
  70
  71     DECL_LINK_TYPED(DelayTrigger, Timer*, void);
  72 };
  73
  74 } } } // end of namespace ::sd::slidesorter::view
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */