blob: 918934d0a99be5d08f907e27cdb01c600c98c335 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SD_SLIDESORTER_VIEW_TOOL_TIP_HXX
#define SD_SLIDESORTER_VIEW_TOOL_TIP_HXX
#include "SlideSorter.hxx"
#include "model/SlsSharedPageDescriptor.hxx"
namespace sd { namespace slidesorter { namespace view {
/** Manage the display of tool tips. The tool tip text changes when the
mouse is moved from slide to slide or from button to button.
After the mouse enters a slide the first display of the tool tip is
delayed for a short time in order to not draw attention from the slide
or its button bar.
*/
class ToolTip
{
public:
ToolTip (SlideSorter& rSlideSorter);
~ToolTip (void);
/** Set a new page. This modifies the default help text. After a page
change a timer is started to delay the display of the tool tip for
the new page.
@param rpPage
When this is empty then the tool tip is hidden.
*/
void SetPage (const model::SharedPageDescriptor& rpPage);
/** Set and show the default help text.
*/
void ShowDefaultHelpText (const ::rtl::OUString& rsHelpText);
/** Show a previously set default help text.
*/
void ShowDefaultHelpText (void);
/** Show a temporary help text.
*/
void ShowHelpText (const ::rtl::OUString& rsHelpText);
/** Hide the tool tip.
@return
Returns whether the tool tip was visible at the time this method
was called.
*/
bool Hide (void);
private:
SlideSorter& mrSlideSorter;
model::SharedPageDescriptor mpDescriptor;
::rtl::OUString msDefaultHelpText;
::rtl::OUString msCurrentHelpText;
sal_uLong mnHelpWindowHandle;
Timer maTimer;
/** Request to show the tool tip.
@param bForce
When <TRUE/> then the tool tip is show right away. Otherwise it
is shown after a short delay.
*/
void Show (const bool bForce);
void DoShow (void);
DECL_LINK(DelayTrigger, void*);
};
} } } // end of namespace ::sd::slidesorter::view
#endif
|
