LibreOffice Module sd (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
sd::slidesorter::view::ToolTip Class Reference

Manage the display of tool tips. More...

#include <SlsToolTip.hxx>

Collaboration diagram for sd::slidesorter::view::ToolTip:
[legend]

Public Member Functions

 ToolTip (SlideSorter &rSlideSorter)
 
 ~ToolTip ()
 
void SetPage (const model::SharedPageDescriptor &rpPage)
 Set a new page. More...
 
bool Hide ()
 Hide the tool tip. More...
 

Private Member Functions

void DoShow ()
 
 DECL_LINK (DelayTrigger, Timer *, void)
 

Private Attributes

SlideSortermrSlideSorter
 
model::SharedPageDescriptor mpDescriptor
 
OUString msCurrentHelpText
 
void * mnHelpWindowHandle
 
Timer maShowTimer
 
Timer maHiddenTimer
 

Detailed Description

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.

Definition at line 39 of file SlsToolTip.hxx.

Constructor & Destructor Documentation

◆ ToolTip()

sd::slidesorter::view::ToolTip::ToolTip ( SlideSorter rSlideSorter)

◆ ~ToolTip()

sd::slidesorter::view::ToolTip::~ToolTip ( )

Definition at line 47 of file SlsToolTip.cxx.

References Hide(), maHiddenTimer, maShowTimer, and Task::Stop().

Member Function Documentation

◆ DECL_LINK()

sd::slidesorter::view::ToolTip::DECL_LINK ( DelayTrigger  ,
Timer ,
void   
)
private

◆ DoShow()

void sd::slidesorter::view::ToolTip::DoShow ( )
private

◆ Hide()

bool sd::slidesorter::view::ToolTip::Hide ( )

Hide the tool tip.

Returns
Returns whether the tool tip was visible at the time this method was called.

Definition at line 140 of file SlsToolTip.cxx.

References VclPtr< class reference_type >::get(), sd::slidesorter::SlideSorter::GetContentWindow(), Help::HidePopover(), mnHelpWindowHandle, and mrSlideSorter.

Referenced by SetPage(), and ~ToolTip().

◆ SetPage()

void sd::slidesorter::view::ToolTip::SetPage ( const model::SharedPageDescriptor rpPage)

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.

Parameters
rpPageWhen this is empty then the tool tip is hidden.

Definition at line 54 of file SlsToolTip.cxx.

References DoShow(), SdPage::GetName(), Hide(), Task::IsActive(), maHiddenTimer, maShowTimer, mpDescriptor, msCurrentHelpText, SdResId(), Timer::Start(), and Task::Stop().

Member Data Documentation

◆ maHiddenTimer

Timer sd::slidesorter::view::ToolTip::maHiddenTimer
private

Definition at line 66 of file SlsToolTip.hxx.

Referenced by SetPage(), ToolTip(), and ~ToolTip().

◆ maShowTimer

Timer sd::slidesorter::view::ToolTip::maShowTimer
private

Definition at line 65 of file SlsToolTip.hxx.

Referenced by DoShow(), SetPage(), ToolTip(), and ~ToolTip().

◆ mnHelpWindowHandle

void* sd::slidesorter::view::ToolTip::mnHelpWindowHandle
private

Definition at line 64 of file SlsToolTip.hxx.

Referenced by DoShow(), and Hide().

◆ mpDescriptor

model::SharedPageDescriptor sd::slidesorter::view::ToolTip::mpDescriptor
private

Definition at line 62 of file SlsToolTip.hxx.

Referenced by DoShow(), and SetPage().

◆ mrSlideSorter

SlideSorter& sd::slidesorter::view::ToolTip::mrSlideSorter
private

Definition at line 61 of file SlsToolTip.hxx.

Referenced by DoShow(), and Hide().

◆ msCurrentHelpText

OUString sd::slidesorter::view::ToolTip::msCurrentHelpText
private

Definition at line 63 of file SlsToolTip.hxx.

Referenced by DoShow(), and SetPage().


The documentation for this class was generated from the following files: