tdf#85428: Clip strokes
[LibreOffice.git] / sd / source / ui / slidesorter / inc / view / SlsToolTip.hxx
blob6c3557e6477e1a44fb78857963db82a10f5c9e3e
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #pragma once
22 #include <model/SlsSharedPageDescriptor.hxx>
23 #include <rtl/ustring.hxx>
24 #include <vcl/timer.hxx>
26 namespace sd::slidesorter
28 class SlideSorter;
31 namespace sd::slidesorter::view
33 /** Manage the display of tool tips. The tool tip text changes when the
34 mouse is moved from slide to slide or from button to button.
35 After the mouse enters a slide the first display of the tool tip is
36 delayed for a short time in order to not draw attention from the slide
37 or its button bar.
39 class ToolTip
41 public:
42 ToolTip(SlideSorter& rSlideSorter);
43 ~ToolTip();
45 /** Set a new page. This modifies the default help text. After a page
46 change a timer is started to delay the display of the tool tip for
47 the new page.
48 @param rpPage
49 When this is empty then the tool tip is hidden.
51 void SetPage(const model::SharedPageDescriptor& rpPage);
53 /** Hide the tool tip.
54 @return
55 Returns whether the tool tip was visible at the time this method
56 was called.
58 bool Hide();
60 private:
61 SlideSorter& mrSlideSorter;
62 model::SharedPageDescriptor mpDescriptor;
63 OUString msCurrentHelpText;
64 void* mnHelpWindowHandle;
65 Timer maShowTimer;
66 Timer maHiddenTimer;
68 void DoShow();
70 DECL_LINK(DelayTrigger, Timer*, void);
73 } // end of namespace ::sd::slidesorter::view
75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */