LibreOffice Module vcl (master)  1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
HelpTextWindow Class Referencefinal

A tooltip: adds tips to widgets in a floating / popup window. More...

#include <helpwin.hxx>

Inheritance diagram for HelpTextWindow:
Collaboration diagram for HelpTextWindow:

Public Member Functions

 HelpTextWindow (vcl::Window *pParent, const OUString &rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle)
virtual ~HelpTextWindow () override
const OUString & GetHelpText () const
void SetHelpText (const OUString &rHelpText)
sal_uInt16 GetWinStyle () const
QuickHelpFlags GetStyle () const
void SetHelpArea (const tools::Rectangle &rRect)
void ShowHelp (bool bNoDelay)
Size CalcOutSize () const
const tools::RectangleGetHelpArea () const
- Public Member Functions inherited from FloatingWindow
SAL_DLLPRIVATE FloatingWindowImplFloatHitTest (vcl::Window *pReference, const Point &rPos, bool &rbHitTestInsideRect)
SAL_DLLPRIVATE FloatingWindowImplFindLastLevelFloat ()
SAL_DLLPRIVATE bool ImplIsFloatPopupModeWindow (const vcl::Window *pWindow)
SAL_DLLPRIVATE void ImplSetMouseDown ()
SAL_DLLPRIVATE bool ImplIsMouseDown () const
SAL_DLLPRIVATE void ImplEndPopupMode (FloatWinPopupEndFlags nFlags, const VclPtr< vcl::Window > &xFocusId)
SAL_DLLPRIVATE tools::RectangleImplGetItemEdgeClipRect ()
SAL_DLLPRIVATE bool ImplIsInPrivatePopupMode () const
virtual void doDeferredInit (WinBits nBits) override
void PixelInvalidate (const tools::Rectangle *pRectangle) override
 Notification about some rectangle of the output device got invalidated. More...
 FloatingWindow (vcl::Window *pParent, WinBits nStyle)
 FloatingWindow (vcl::Window *pParent, const OString &rID, const OUString &rUIXMLDescription, const css::uno::Reference< css::frame::XFrame > &rFrame=css::uno::Reference< css::frame::XFrame >())
virtual ~FloatingWindow () override
virtual bool EventNotify (NotifyEvent &rNEvt) override
virtual void StateChanged (StateChangedType nType) override
virtual void DataChanged (const DataChangedEvent &rDCEvt) override
virtual void PopupModeEnd ()
void SetTitleType (FloatWinTitleType nTitle)
FloatWinTitleType GetTitleType () const
void StartPopupMode (const tools::Rectangle &rRect, FloatWinPopupFlags nFlags)
void StartPopupMode (ToolBox *pBox, FloatWinPopupFlags nFlags)
void EndPopupMode (FloatWinPopupEndFlags nFlags=FloatWinPopupEndFlags::NONE)
void AddPopupModeWindow (vcl::Window *pWindow)
FloatWinPopupFlags GetPopupModeFlags () const
void SetPopupModeFlags (FloatWinPopupFlags nFlags)
bool IsInPopupMode () const
bool IsInCleanUp () const
bool IsPopupModeCanceled () const
bool IsPopupModeTearOff () const
void SetPopupModeEndHdl (const Link< FloatingWindow *, void > &rLink)
bool GrabsFocus () const
- Public Member Functions inherited from SystemWindow
SAL_DLLPRIVATE bool ImplIsInTaskPaneList (vcl::Window *pWin)
SAL_DLLPRIVATE bool isDeferredInit () const
virtual ~SystemWindow () override
virtual bool PreNotify (NotifyEvent &rNEvt) override
virtual bool Close ()
virtual void TitleButtonClick (TitleButton nButton)
virtual void Resizing (Size &rSize)
virtual void Resize () override
virtual Size GetOptimalSize () const override
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout) override
bool isLayoutEnabled () const
void setOptimalLayoutSize ()
bool isCalculatingInitialLayoutSize () const
void SetIcon (sal_uInt16 nIcon)
sal_uInt16 GetIcon () const
void SetRepresentedURL (const OUString &)
void ShowTitleButton (TitleButton nButton, bool bVisible)
bool IsTitleButtonVisible (TitleButton nButton) const
void SetMinOutputSizePixel (const Size &rSize)
const SizeGetMinOutputSizePixel () const
void SetMaxOutputSizePixel (const Size &rSize)
const SizeGetMaxOutputSizePixel () const
void SetWindowState (const OString &rStr)
OString GetWindowState (WindowStateMask nMask=WindowStateMask::All) const
void SetMenuBar (MenuBar *pMenuBar)
MenuBarGetMenuBar () const
void SetMenuBarMode (MenuBarMode nMode)
void CollectMenuBarMnemonics (MnemonicGenerator &rMnemonicGenerator) const
int GetMenuBarHeight () const
void SetNotebookBar (const OUString &rUIXMLDescription, const css::uno::Reference< css::frame::XFrame > &rFrame, const NotebookBarAddonsItem &aNotebookBarAddonsItem, bool bReloadNotebookbar=false)
void CloseNotebookBar ()
VclPtr< NotebookBar > const & GetNotebookBar () const
TaskPaneListGetTaskPaneList ()
void GetWindowStateData (WindowStateData &rData) const
virtual void SetText (const OUString &rStr) override
unsigned int GetScreenNumber () const
 Returns the screen number the window is on. More...
void SetScreenNumber (unsigned int nNewScreen)
 Move the Window to a new screen. More...
void SetApplicationID (const OUString &rApplicationID)
bool UpdatePositionData ()
void SetCloseHdl (const Link< SystemWindow &, void > &rLink)
const Link< SystemWindow &, void > & GetCloseHdl () const
SAL_DLLPRIVATE bool hasPendingLayout () const
VclPtr< VirtualDevicecreateScreenshot ()
- Public Member Functions inherited from vcl::Window
 DECL_DLLPRIVATE_LINK (ImplHandlePaintHdl, Timer *, void)
 DECL_DLLPRIVATE_LINK (ImplGenerateMouseMoveHdl, void *, void)
 DECL_DLLPRIVATE_LINK (ImplTrackTimerHdl, Timer *, void)
 DECL_DLLPRIVATE_LINK (ImplAsyncFocusHdl, void *, void)
 DECL_DLLPRIVATE_LINK (ImplHandleResizeTimerHdl, Timer *, void)
SAL_DLLPRIVATE vcl::WindowImplGetFrameWindow () const
weld::WindowGetFrameWeld () const
vcl::WindowGetFrameWindow () const
SalFrameImplGetFrame () const
SAL_DLLPRIVATE ImplFrameDataImplGetFrameData ()
vcl::WindowImplGetWindow () const
 if this is a proxy return the client, otherwise itself More...
SAL_DLLPRIVATE ImplWinDataImplGetWinData () const
SAL_DLLPRIVATE vcl::WindowImplGetClientWindow () const
SAL_DLLPRIVATE vcl::WindowImplGetDlgWindow (sal_uInt16 n, GetDlgWindowType nType, sal_uInt16 nStart=0, sal_uInt16 nEnd=0xFFFF, sal_uInt16 *pIndex=nullptr)
SAL_DLLPRIVATE vcl::WindowImplGetParent () const
SAL_DLLPRIVATE vcl::WindowImplFindWindow (const Point &rFramePos)
SAL_DLLPRIVATE void ImplInvalidateFrameRegion (const vcl::Region *pRegion, InvalidateFlags nFlags)
SAL_DLLPRIVATE void ImplInvalidateOverlapFrameRegion (const vcl::Region &rRegion)
SAL_DLLPRIVATE bool ImplSetClipFlag (bool bSysObjOnlySmaller=false)
SAL_DLLPRIVATE bool ImplIsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
SAL_DLLPRIVATE bool ImplIsChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
SAL_DLLPRIVATE bool ImplIsFloatingWindow () const
SAL_DLLPRIVATE bool ImplIsPushButton () const
SAL_DLLPRIVATE bool ImplIsSplitter () const
SAL_DLLPRIVATE bool ImplIsOverlapWindow () const
SAL_DLLPRIVATE void ImplIsInTaskPaneList (bool mbIsInTaskList)
SAL_DLLPRIVATE WindowImplImplGetWindowImpl () const
SAL_DLLPRIVATE Point ImplFrameToOutput (const Point &rPos)
SAL_DLLPRIVATE void ImplGrabFocus (GetFocusFlags nFlags)
SAL_DLLPRIVATE void ImplGrabFocusToDocument (GetFocusFlags nFlags)
SAL_DLLPRIVATE void ImplInvertFocus (const tools::Rectangle &rRect)
SAL_DLLPRIVATE PointerStyle ImplGetMousePointer () const
SAL_DLLPRIVATE void ImplCallMouseMove (sal_uInt16 nMouseCode, bool bModChanged=false)
SAL_DLLPRIVATE void ImplGenerateMouseMove ()
SAL_DLLPRIVATE void ImplNotifyKeyMouseCommandEventListeners (NotifyEvent &rNEvt)
SAL_DLLPRIVATE void ImplNotifyIconifiedState (bool bIconified)
SAL_DLLPRIVATE void ImplUpdateAll ()
SAL_DLLPRIVATE void ImplControlFocus (GetFocusFlags nFlags=GetFocusFlags::NONE)
SAL_DLLPRIVATE void ImplMirrorFramePos (Point &pt) const
SAL_DLLPRIVATE void ImplPosSizeWindow (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, PosSizeFlags nFlags)
SAL_DLLPRIVATE void ImplCallResize ()
SAL_DLLPRIVATE void ImplCallMove ()
void IncModalCount ()
void DecModalCount ()
 Window (vcl::Window *pParent, WinBits nStyle=0)
virtual ~Window () override
::OutputDevice const * GetOutDev () const
::OutputDeviceGetOutDev ()
Color GetBackgroundColor () const
const WallpaperGetBackground () const
bool IsBackground () const
const MapModeGetMapMode () const
void SetBackground ()
void SetBackground (const Wallpaper &rBackground)
virtual void MouseMove (const MouseEvent &rMEvt)
virtual void MouseButtonDown (const MouseEvent &rMEvt)
virtual void MouseButtonUp (const MouseEvent &rMEvt)
virtual void KeyInput (const KeyEvent &rKEvt)
virtual void KeyUp (const KeyEvent &rKEvt)
void Erase (vcl::RenderContext &rRenderContext)
virtual void Draw (::OutputDevice *pDev, const Point &rPos, DrawFlags nFlags)
virtual void Move ()
virtual void Activate ()
virtual void Deactivate ()
virtual void GetFocus ()
virtual void LoseFocus ()
virtual void Command (const CommandEvent &rCEvt)
virtual void Tracking (const TrackingEvent &rTEvt)
void CompatGetFocus ()
void CompatLoseFocus ()
void CompatStateChanged (StateChangedType nStateChange)
void CompatDataChanged (const DataChangedEvent &rDCEvt)
bool CompatPreNotify (NotifyEvent &rNEvt)
bool CompatNotify (NotifyEvent &rNEvt)
void AddEventListener (const Link< VclWindowEvent &, void > &rEventListener)
void RemoveEventListener (const Link< VclWindowEvent &, void > &rEventListener)
void AddChildEventListener (const Link< VclWindowEvent &, void > &rEventListener)
void RemoveChildEventListener (const Link< VclWindowEvent &, void > &rEventListener)
ImplSVEventPostUserEvent (const Link< void *, void > &rLink, void *pCaller=nullptr, bool bReferenceLink=false)
void RemoveUserEvent (ImplSVEvent *nUserEvent)
LanguageType GetInputLanguage () const
void SetStyle (WinBits nStyle)
WinBits GetStyle () const
WinBits GetPrevStyle () const
void SetExtendedStyle (WindowExtendedStyle nExtendedStyle)
WindowExtendedStyle GetExtendedStyle () const
void SetType (WindowType nType)
WindowType GetType () const
bool IsSystemWindow () const
bool IsDockingWindow () const
bool IsDialog () const
bool IsMenuFloatingWindow () const
bool IsToolbarFloatingWindow () const
bool IsTopWindow () const
SystemWindowGetSystemWindow () const
bool SupportsDoubleBuffering () const
 Can the widget derived from this Window do the double-buffering via RenderContext properly? More...
void RequestDoubleBuffering (bool bRequest)
 Enable/disable double-buffering of the frame window and all its children. More...
void EnableAllResize ()
void SetBorderStyle (WindowBorderStyle nBorderStyle)
WindowBorderStyle GetBorderStyle () const
void GetBorder (sal_Int32 &rLeftBorder, sal_Int32 &rTopBorder, sal_Int32 &rRightBorder, sal_Int32 &rBottomBorder) const
Size CalcWindowSize (const Size &rOutSz) const
Size CalcOutputSize (const Size &rWinSz) const
tools::Long CalcTitleWidth () const
void EnableClipSiblings (bool bClipSiblings=true)
void EnableChildTransparentMode (bool bEnable=true)
bool IsChildTransparentModeEnabled () const
void SetMouseTransparent (bool bTransparent)
bool IsMouseTransparent () const
void SetPaintTransparent (bool bTransparent)
bool IsPaintTransparent () const
void SetDialogControlStart (bool bStart)
bool IsDialogControlStart () const
void SetDialogControlFlags (DialogControlFlags nFlags)
DialogControlFlags GetDialogControlFlags () const
PointerState GetPointerState ()
bool IsMouseOver () const
void SetInputContext (const InputContext &rInputContext)
const InputContextGetInputContext () const
void PostExtTextInputEvent (VclEventId nType, const OUString &rText)
void EndExtTextInput ()
void SetCursorRect (const tools::Rectangle *pRect=nullptr, tools::Long nExtTextInputWidth=0)
const tools::RectangleGetCursorRect () const
tools::Long GetCursorExtTextInputWidth () const
void SetCompositionCharRect (const tools::Rectangle *pRect, tools::Long nCompositionLength, bool bVertical=false)
void UpdateSettings (const AllSettings &rSettings, bool bChild=false)
void NotifyAllChildren (DataChangedEvent &rDCEvt)
void SetPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
vcl::Font GetPointFont (vcl::RenderContext const &rRenderContext) const
void SetZoomedPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
tools::Long GetDrawPixel (::OutputDevice const *pDev, tools::Long nPixels) const
vcl::Font GetDrawPixelFont (::OutputDevice const *pDev) const
void SetControlFont ()
void SetControlFont (const vcl::Font &rFont)
vcl::Font GetControlFont () const
bool IsControlFont () const
void ApplyControlFont (vcl::RenderContext &rRenderContext, const vcl::Font &rDefaultFont)
void SetControlForeground ()
void SetControlForeground (const Color &rColor)
const ColorGetControlForeground () const
bool IsControlForeground () const
void ApplyControlForeground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
void SetControlBackground ()
void SetControlBackground (const Color &rColor)
const ColorGetControlBackground () const
bool IsControlBackground () const
void ApplyControlBackground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
void SetParentClipMode (ParentClipMode nMode=ParentClipMode::NONE)
ParentClipMode GetParentClipMode () const
void SetWindowRegionPixel ()
void SetWindowRegionPixel (const vcl::Region &rRegion)
vcl::Region GetWindowClipRegionPixel () const
vcl::Region GetPaintRegion () const
bool IsInPaint () const
void ExpandPaintClipRegion (const vcl::Region &rRegion)
void SetParent (vcl::Window *pNewParent)
vcl::WindowGetParent () const
DialogGetParentDialog () const
bool IsAncestorOf (const vcl::Window &rWindow) const
void Show (bool bVisible=true, ShowFlags nFlags=ShowFlags::NONE)
void Hide ()
bool IsVisible () const
bool IsReallyVisible () const
bool IsReallyShown () const
bool IsInInitShow () const
void Enable (bool bEnable=true, bool bChild=true)
void Disable (bool bChild=true)
bool IsEnabled () const
void EnableInput (bool bEnable=true, bool bChild=true)
void EnableInput (bool bEnable, const vcl::Window *pExcludeWindow)
bool IsInputEnabled () const
void AlwaysEnableInput (bool bAlways, bool bChild=true)
 Override EnableInput. More...
bool IsAlwaysEnableInput () const
 returns the current AlwaysEnableInput state More...
bool IsInModalMode () const
 A window is in modal mode if one of its children or subchildren is a running modal window (a modal dialog) More...
void SetActivateMode (ActivateModeFlags nMode)
ActivateModeFlags GetActivateMode () const
void ToTop (ToTopFlags nFlags=ToTopFlags::NONE)
void SetZOrder (vcl::Window *pRefWindow, ZOrderFlags nFlags)
void EnableAlwaysOnTop (bool bEnable=true)
bool IsAlwaysOnTopEnabled () const
virtual void setPosSizePixel (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, PosSizeFlags nFlags=PosSizeFlags::All)
virtual void SetPosPixel (const Point &rNewPos)
virtual Point GetPosPixel () const
virtual void SetSizePixel (const Size &rNewSize)
virtual Size GetSizePixel () const
virtual void SetPosSizePixel (const Point &rNewPos, const Size &rNewSize)
virtual void SetOutputSizePixel (const Size &rNewSize)
bool IsDefaultPos () const
bool IsDefaultSize () const
Point GetOffsetPixelFrom (const vcl::Window &rWindow) const
Point OutputToScreenPixel (const Point &rPos) const
Point ScreenToOutputPixel (const Point &rPos) const
Point OutputToNormalizedScreenPixel (const Point &rPos) const
Point NormalizedScreenToOutputPixel (const Point &rPos) const
Point OutputToAbsoluteScreenPixel (const Point &rPos) const
Point AbsoluteScreenToOutputPixel (const Point &rPos) const
tools::Rectangle GetDesktopRectPixel () const
tools::Rectangle GetWindowExtentsRelative (const vcl::Window *pRelativeWindow) const
bool IsScrollable () const
virtual void Scroll (tools::Long nHorzScroll, tools::Long nVertScroll, ScrollFlags nFlags=ScrollFlags::NONE)
void Scroll (tools::Long nHorzScroll, tools::Long nVertScroll, const tools::Rectangle &rRect, ScrollFlags nFlags=ScrollFlags::NONE)
virtual void Invalidate (InvalidateFlags nFlags=InvalidateFlags::NONE)
virtual void Invalidate (const tools::Rectangle &rRect, InvalidateFlags nFlags=InvalidateFlags::NONE)
virtual void Invalidate (const vcl::Region &rRegion, InvalidateFlags nFlags=InvalidateFlags::NONE)
virtual void LogicInvalidate (const tools::Rectangle *pRectangle)
 Notification about some rectangle of the output device got invalidated.Used for the main document window. More...
void Validate ()
bool HasPaintEvent () const
void PaintImmediately ()
void EnableDocking (bool bEnable=true)
void EnablePaint (bool bEnable)
bool IsPaintEnabled () const
void SetUpdateMode (bool bUpdate)
bool IsUpdateMode () const
void SetParentUpdateMode (bool bUpdate)
void GrabFocus ()
bool HasFocus () const
bool HasChildPathFocus (bool bSystemWindow=false) const
bool IsActive () const
bool HasActiveChildFrame () const
GetFocusFlags GetGetFocusFlags () const
void GrabFocusToDocument ()
VclPtr< vcl::WindowGetFocusedWindow () const
void SetFakeFocus (bool bFocus)
 Set this when you need to act as if the window has focus even if it doesn't. More...
bool IsCompoundControl () const
void CaptureMouse ()
void ReleaseMouse ()
bool IsMouseCaptured () const
void SetPointer (PointerStyle)
PointerStyle GetPointer () const
void EnableChildPointerOverwrite (bool bOverwrite)
void SetPointerPosPixel (const Point &rPos)
Point GetPointerPosPixel ()
Point GetLastPointerPosPixel ()
void SetLastMousePos (const Point &rPos)
 Similar to SetPointerPosPixel(), but sets the frame data's last mouse position instead. More...
void ShowPointer (bool bVisible)
void EnterWait ()
void LeaveWait ()
bool IsWait () const
void SetCursor (vcl::Cursor *pCursor)
vcl::CursorGetCursor () const
void SetZoom (const Fraction &rZoom)
const FractionGetZoom () const
bool IsZoom () const
tools::Long CalcZoom (tools::Long n) const
virtual OUString GetDisplayText () const
virtual const WallpaperGetDisplayBackground () const
void SetHelpText (const OUString &rHelpText)
const OUString & GetHelpText () const
void SetQuickHelpText (const OUString &rHelpText)
const OUString & GetQuickHelpText () const
void SetHelpId (const OString &)
const OString & GetHelpId () const
sal_uInt16 GetChildCount () const
vcl::WindowGetChild (sal_uInt16 nChild) const
vcl::WindowGetWindow (GetWindowType nType) const
bool IsChild (const vcl::Window *pWindow) const
bool IsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
SAL_DLLPRIVATE void CollectChildren (::std::vector< vcl::Window * > &rAllChildren)
 Add all children to rAllChildren recursively. More...
virtual void ShowFocus (const tools::Rectangle &rRect)
void HideFocus ()
void DrawSelectionBackground (const tools::Rectangle &rRect, sal_uInt16 highlight, bool bChecked, bool bDrawBorder)
void ShowTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags=ShowTrackFlags::Small)
void HideTracking ()
void InvertTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags)
void StartTracking (StartTrackingFlags nFlags=StartTrackingFlags::NONE)
void EndTracking (TrackingEventFlags nFlags=TrackingEventFlags::NONE)
bool IsTracking () const
void StartAutoScroll (StartAutoScrollFlags nFlags)
void EndAutoScroll ()
bool HandleScrollCommand (const CommandEvent &rCmd, ScrollBar *pHScrl, ScrollBar *pVScrl)
virtual const SystemEnvDataGetSystemData () const
virtual css::uno::Reference< css::awt::XWindowPeer > GetComponentInterface (bool bCreate=true)
void SetComponentInterface (css::uno::Reference< css::awt::XWindowPeer > const &xIFace)
void SetLOKNotifier (const vcl::ILibreOfficeKitNotifier *pNotifier, bool bParent=false)
 Interface to register for dialog / window tunneling. More...
const vcl::ILibreOfficeKitNotifier * GetLOKNotifier () const
vcl::LOKWindowId GetLOKWindowId () const
VclPtr< vcl::WindowGetParentWithLOKNotifier ()
 Find the nearest parent with LOK Notifier; can be itself if this Window has LOK notifier set. More...
void ReleaseLOKNotifier ()
 Indicate that LOK is not going to use this dialog any more. More...
virtual void DumpAsPropertyTree (tools::JsonWriter &)
 Dumps itself and potentially its children to a property tree, to be written easily to JSON. More...
virtual void LogicMouseButtonDown (const MouseEvent &)
 Same as MouseButtonDown(), but coordinates are in logic unit. used for LOK. More...
virtual void LogicMouseButtonUp (const MouseEvent &)
 Same as MouseButtonUp(), but coordinates are in logic unit. used for LOK. More...
virtual void LogicMouseMove (const MouseEvent &)
 Same as MouseMove(), but coordinates are in logic unit. used for LOK. More...
void RecordLayoutData (vcl::ControlLayoutData *pLayout, const tools::Rectangle &rRect)
VCLXWindowGetWindowPeer () const
void SetWindowPeer (css::uno::Reference< css::awt::XWindowPeer > const &xPeer, VCLXWindow *pVCLXWindow)
bool IsCreatedWithToolkit () const
void SetCreatedWithToolkit (bool b)
css::uno::Reference< css::datatransfer::dnd::XDropTarget > GetDropTarget ()
css::uno::Reference< css::datatransfer::dnd::XDragSource > GetDragSource ()
css::uno::Reference< css::datatransfer::dnd::XDragGestureRecognizer > GetDragGestureRecognizer ()
css::uno::Reference< css::datatransfer::clipboard::XClipboard > GetClipboard ()
void SetClipboard (css::uno::Reference< css::datatransfer::clipboard::XClipboard > const &xClipboard)
 Sets a custom clipboard for the window's frame, instead of creating it on-demand using css::datatransfer::clipboard::SystemClipboard. More...
void set_height_request (sal_Int32 nHeightRequest)
sal_Int32 get_height_request () const
void set_width_request (sal_Int32 nWidthRequest)
sal_Int32 get_width_request () const
Size get_preferred_size () const
VclAlign get_halign () const
void set_halign (VclAlign eAlign)
VclAlign get_valign () const
void set_valign (VclAlign eAlign)
bool get_hexpand () const
void set_hexpand (bool bExpand)
bool get_vexpand () const
void set_vexpand (bool bExpand)
bool get_expand () const
void set_expand (bool bExpand)
bool get_fill () const
void set_fill (bool bFill)
void set_border_width (sal_Int32 nBorderWidth)
sal_Int32 get_border_width () const
void set_margin_start (sal_Int32 nWidth)
sal_Int32 get_margin_start () const
void set_margin_end (sal_Int32 nWidth)
sal_Int32 get_margin_end () const
void set_margin_top (sal_Int32 nWidth)
sal_Int32 get_margin_top () const
void set_margin_bottom (sal_Int32 nWidth)
sal_Int32 get_margin_bottom () const
VclPackType get_pack_type () const
void set_pack_type (VclPackType ePackType)
sal_Int32 get_padding () const
void set_padding (sal_Int32 nPadding)
sal_Int32 get_grid_width () const
void set_grid_width (sal_Int32 nCols)
sal_Int32 get_grid_left_attach () const
void set_grid_left_attach (sal_Int32 nAttach)
sal_Int32 get_grid_height () const
void set_grid_height (sal_Int32 nRows)
sal_Int32 get_grid_top_attach () const
void set_grid_top_attach (sal_Int32 nAttach)
bool get_secondary () const
void set_secondary (bool bSecondary)
bool get_non_homogeneous () const
void set_non_homogeneous (bool bNonHomogeneous)
virtual bool set_property (const OString &rKey, const OUString &rValue)
bool set_font_attribute (const OString &rKey, const OUString &rValue)
void add_to_size_group (const std::shared_ptr< VclSizeGroup > &xGroup)
void remove_from_all_size_groups ()
void add_mnemonic_label (FixedText *pLabel)
void remove_mnemonic_label (FixedText *pLabel)
const std::vector< VclPtr< FixedText > > & list_mnemonic_labels () const
void reorderWithinParent (sal_uInt16 nNewPosition)
void set_id (const OUString &rID)
 Sets an ID. More...
const OUString & get_id () const
 Get the ID of the window. More...
void EnableNativeWidget (bool bEnable=true)
bool IsNativeWidgetEnabled () const
void PaintToDevice (::OutputDevice *pDevice, const Point &rPos)
void SetParentToDefaultWindow ()
KeyIndicatorState GetIndicatorState () const
 Query the states of keyboard indicators - Caps Lock, Num Lock and Scroll Lock. More...
void SimulateKeyPress (sal_uInt16 nKeyCode) const
virtual OUString GetSurroundingText () const
virtual Selection GetSurroundingTextSelection () const
virtual bool DeleteSurroundingText (const Selection &rSelection)
virtual FactoryFunction GetUITestFactory () const
virtual bool IsChart () const
void SetHelpHdl (const Link< vcl::Window &, bool > &rLink)
void SetMnemonicActivateHdl (const Link< vcl::Window &, bool > &rLink)
void SetModalHierarchyHdl (const Link< bool, void > &rLink)
void SetDumpAsPropertyTreeHdl (const Link< tools::JsonWriter &, void > &rLink)
Size GetOutputSizePixel () const
tools::Rectangle GetOutputRectPixel () const
Point LogicToPixel (const Point &rLogicPt) const
Size LogicToPixel (const Size &rLogicSize) const
tools::Rectangle LogicToPixel (const tools::Rectangle &rLogicRect) const
vcl::Region LogicToPixel (const vcl::Region &rLogicRegion) const
Point LogicToPixel (const Point &rLogicPt, const MapMode &rMapMode) const
Size LogicToPixel (const Size &rLogicSize, const MapMode &rMapMode) const
tools::Rectangle LogicToPixel (const tools::Rectangle &rLogicRect, const MapMode &rMapMode) const
Point PixelToLogic (const Point &rDevicePt) const
Size PixelToLogic (const Size &rDeviceSize) const
tools::Rectangle PixelToLogic (const tools::Rectangle &rDeviceRect) const
tools::PolyPolygon PixelToLogic (const tools::PolyPolygon &rDevicePolyPoly) const
vcl::Region PixelToLogic (const vcl::Region &rDeviceRegion) const
Point PixelToLogic (const Point &rDevicePt, const MapMode &rMapMode) const
Size PixelToLogic (const Size &rDeviceSize, const MapMode &rMapMode) const
tools::Rectangle PixelToLogic (const tools::Rectangle &rDeviceRect, const MapMode &rMapMode) const
Size LogicToLogic (const Size &rSzSource, const MapMode *pMapModeSource, const MapMode *pMapModeDest) const
const AllSettingsGetSettings () const
void SetSettings (const AllSettings &rSettings)
void SetSettings (const AllSettings &rSettings, bool bChild)
tools::Rectangle GetTextRect (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle=DrawTextFlags::WordBreak, TextRectInfo *pInfo=nullptr, const vcl::ITextLayout *_pTextLayout=nullptr) const
float GetDPIScaleFactor () const
tools::Long GetOutOffXPixel () const
tools::Long GetOutOffYPixel () const
void EnableMapMode (bool bEnable=true)
bool IsMapModeEnabled () const
void SetMapMode ()
void SetMapMode (const MapMode &rNewMapMode)
virtual void EnableRTL (bool bEnable=true)
bool IsRTLEnabled () const
void SetFont (const vcl::Font &rNewFont)
const vcl::FontGetFont () const
tools::Long GetTextWidth (const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, vcl::TextLayoutCache const *=nullptr, SalLayoutGlyphs const *const pLayoutCache=nullptr) const
 Width of the text. More...
tools::Long GetTextHeight () const
 Height where any character of the current font fits; in logic coordinates. More...
float approximate_digit_width () const
void SetTextColor (const Color &rColor)
const ColorGetTextColor () const
void SetTextFillColor ()
void SetTextFillColor (const Color &rColor)
Color GetTextFillColor () const
bool IsTextFillColor () const
void SetTextLineColor ()
void SetTextLineColor (const Color &rColor)
const ColorGetTextLineColor () const
bool IsTextLineColor () const
void SetOverlineColor ()
void SetOverlineColor (const Color &rColor)
const ColorGetOverlineColor () const
bool IsOverlineColor () const
void SetTextAlign (TextAlign eAlign)
TextAlign GetTextAlign () const
bool IsNativeControlSupported (ControlType nType, ControlPart nPart) const
 Query the platform layer for control support. More...
bool GetNativeControlRegion (ControlType nType, ControlPart nPart, const tools::Rectangle &rControlRegion, ControlState nState, const ImplControlValue &aValue, tools::Rectangle &rNativeBoundingRegion, tools::Rectangle &rNativeContentRegion) const
 Query the native control's actual drawing region (including adornment) More...
css::uno::Reference< css::accessibility::XAccessible > GetAccessible (bool bCreate=true)
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible ()
void SetAccessible (const css::uno::Reference< css::accessibility::XAccessible > &)
vcl::WindowGetAccessibleParentWindow () const
sal_uInt16 GetAccessibleChildWindowCount ()
vcl::WindowGetAccessibleChildWindow (sal_uInt16 n)
void SetAccessibleRole (sal_uInt16 nRole)
sal_uInt16 GetAccessibleRole () const
void SetAccessibleName (const OUString &rName)
OUString GetAccessibleName () const
void SetAccessibleDescription (const OUString &rDescr)
OUString GetAccessibleDescription () const
void SetAccessibleRelationLabeledBy (vcl::Window *pLabeledBy)
vcl::WindowGetAccessibleRelationLabeledBy () const
void SetAccessibleRelationLabelFor (vcl::Window *pLabelFor)
vcl::WindowGetAccessibleRelationLabelFor () const
void SetAccessibleRelationMemberOf (vcl::Window *pMemberOf)
vcl::WindowGetAccessibleRelationMemberOf () const
bool IsAccessibilityEventsSuppressed (bool bTraverseParentPath=true)
void SetAccessibilityEventsSuppressed (bool bSuppressed)
KeyEvent GetActivationKey () const
- Public Member Functions inherited from VclReferenceBase
void acquire () const
void release () const
sal_Int32 getRefCount () const
void disposeOnce ()
bool isDisposed () const
- Public Member Functions inherited from VclBuilderContainer
 VclBuilderContainer ()
virtual ~VclBuilderContainer ()
void disposeBuilder ()
void setDeferredProperties ()

Private Member Functions

 DECL_LINK (TimerHdl, Timer *, void)
virtual void Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &) override
virtual void RequestHelp (const HelpEvent &rHEvt) override
virtual void ApplySettings (vcl::RenderContext &rRenderContext) override
virtual OUString GetText () const override
void ImplShow ()
virtual void dispose () override
 This is intended to be used to clear any locally held references to other Window-subclass objects. More...

Private Attributes

tools::Rectangle maHelpArea
tools::Rectangle maTextRect
OUString maHelpText
Timer maShowTimer
Timer maHideTimer
sal_uInt16 mnHelpWinStyle
QuickHelpFlags mnStyle

Additional Inherited Members

- Static Public Member Functions inherited from FloatingWindow
static Point ImplCalcPos (vcl::Window *pWindow, const tools::Rectangle &rRect, FloatWinPopupFlags nFlags, sal_uInt16 &rArrangeIndex, Point *pLOKTwipsPos=nullptr)
static Point ImplConvertToAbsPos (vcl::Window *pReference, const Point &rPos)
static tools::Rectangle ImplConvertToAbsPos (vcl::Window *pReference, const tools::Rectangle &rRect)
static tools::Rectangle ImplConvertToRelPos (vcl::Window *pReference, const tools::Rectangle &rRect)
- Static Public Member Functions inherited from vcl::Window
static SAL_DLLPRIVATE void ImplInitAppFontData (vcl::Window const *pWindow)
static SAL_DLLPRIVATE void ImplCalcSymbolRect (tools::Rectangle &rRect)
static DockingManagerGetDockingManager ()
static VclPtr< vcl::WindowSaveFocus ()
static void EndSaveFocus (const VclPtr< vcl::Window > &xFocusWin)
static VclPtr< vcl::WindowFindLOKWindow (vcl::LOKWindowId nWindowId)
 Find an existing Window based on the LOKWindowId. More...
static bool IsLOKWindowsEmpty ()
 check if LOK Window container is empty More...
static OUString GetNonMnemonicString (const OUString &rStr)
- Protected Member Functions inherited from FloatingWindow
SAL_DLLPRIVATE void ImplInitFloating (vcl::Window *pParent, WinBits nStyle)
SAL_DLLPRIVATE void ImplInitSettings ()
- Protected Member Functions inherited from SystemWindow
 SystemWindow (WindowType nType)
void loadUI (vcl::Window *pParent, const OString &rID, const OUString &rUIXMLDescription, const css::uno::Reference< css::frame::XFrame > &rFrame=css::uno::Reference< css::frame::XFrame >())
void SetWindowStateData (const WindowStateData &rData)
virtual void settingOptimalLayoutSize (Window *pBox)
SAL_DLLPRIVATE void DoInitialLayout ()
SAL_DLLPRIVATE void SetIdleDebugName (const char *pDebugName)
- Protected Member Functions inherited from vcl::Window
SAL_DLLPRIVATE void ImplInit (vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
SAL_DLLPRIVATE Point ImplOutputToFrame (const Point &rPos)
SAL_DLLPRIVATE void ImplInvalidateParentFrameRegion (vcl::Region &rRegion)
SAL_DLLPRIVATE void ImplValidateFrameRegion (const vcl::Region *rRegion, ValidateFlags nFlags)
SAL_DLLPRIVATE void ImplValidate ()
SAL_DLLPRIVATE void ImplMoveInvalidateRegion (const tools::Rectangle &rRect, tools::Long nHorzScroll, tools::Long nVertScroll, bool bChildren)
SAL_DLLPRIVATE void ImplMoveAllInvalidateRegions (const tools::Rectangle &rRect, tools::Long nHorzScroll, tools::Long nVertScroll, bool bChildren)
SAL_DLLPRIVATE vcl::WindowImplGetBorderWindow () const
SAL_DLLPRIVATE void ImplInvalidate (const vcl::Region *rRegion, InvalidateFlags nFlags)
virtual WindowHitTest ImplHitTest (const Point &rFramePos)
SAL_DLLPRIVATE void ImplSetMouseTransparent (bool bTransparent)
SAL_DLLPRIVATE void ImplScroll (const tools::Rectangle &rRect, tools::Long nHorzScroll, tools::Long nVertScroll, ScrollFlags nFlags)
SAL_DLLPRIVATE bool ImplSetClipFlagChildren (bool bSysObjOnlySmaller)
SAL_DLLPRIVATE bool ImplSetClipFlagOverlapWindows (bool bSysObjOnlySmaller=false)
SAL_DLLPRIVATE void PushPaintHelper (PaintHelper *pHelper, vcl::RenderContext &rRenderContext)
SAL_DLLPRIVATE void PopPaintHelper (PaintHelper const *pHelper)
 Window (WindowType nType)
void SetCompoundControl (bool bCompound)
void CallEventListeners (VclEventId nEvent, void *pData=nullptr)
virtual void ImplAdjustNWFSizes ()
SAL_DLLPRIVATE float approximate_char_width () const
SAL_DLLPRIVATE vcl::WindowgetLegacyNonLayoutAccessibleRelationMemberOf () const
SAL_DLLPRIVATE vcl::WindowgetLegacyNonLayoutAccessibleRelationLabeledBy () const
SAL_DLLPRIVATE vcl::WindowgetLegacyNonLayoutAccessibleRelationLabelFor () const
virtual vcl::WindowgetAccessibleRelationLabelFor () const
virtual sal_uInt16 getDefaultAccessibleRole () const
virtual OUString getDefaultAccessibleName () const
void InvalidateSizeCache ()
 clear OptimalSize cache More...
- Protected Member Functions inherited from VclReferenceBase
 VclReferenceBase ()
virtual ~VclReferenceBase ()
- Protected Attributes inherited from SystemWindow
bool mbIsDeferredInit
VclPtr< vcl::WindowmpDialogParent
- Protected Attributes inherited from VclBuilderContainer
std::unique_ptr< VclBuilderm_pUIBuilder

Detailed Description

A tooltip: adds tips to widgets in a floating / popup window.

Definition at line 30 of file helpwin.hxx.

Constructor & Destructor Documentation

HelpTextWindow::HelpTextWindow ( vcl::Window pParent,
const OUString &  rText,
sal_uInt16  nHelpWinStyle,
QuickHelpFlags  nStyle 
HelpTextWindow::~HelpTextWindow ( )

Definition at line 311 of file help.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

void HelpTextWindow::ApplySettings ( vcl::RenderContext rRenderContext)
Size HelpTextWindow::CalcOutSize ( ) const
HelpTextWindow::DECL_LINK ( TimerHdl  ,
Timer ,
void HelpTextWindow::dispose ( void  )

This is intended to be used to clear any locally held references to other Window-subclass objects.

Reimplemented from FloatingWindow.

Definition at line 316 of file help.cxx.

References FloatingWindow::dispose(), ImplGetSVHelpData(), maHideTimer, maShowTimer, ImplSVHelpData::mpHelpWin, and Task::Stop().

const tools::Rectangle& HelpTextWindow::GetHelpArea ( ) const

Definition at line 71 of file helpwin.hxx.

References maHelpArea.

Referenced by ImplShowHelpWindow().

const OUString& HelpTextWindow::GetHelpText ( ) const

Definition at line 60 of file helpwin.hxx.

References maHelpText.

Referenced by ImplShowHelpWindow().

QuickHelpFlags HelpTextWindow::GetStyle ( ) const

Definition at line 63 of file helpwin.hxx.

References mnStyle.

Referenced by Help::UpdatePopover().

OUString HelpTextWindow::GetText ( ) const

Reimplemented from SystemWindow.

Definition at line 475 of file help.cxx.

References maHelpText.

sal_uInt16 HelpTextWindow::GetWinStyle ( ) const

Definition at line 62 of file helpwin.hxx.

References mnHelpWinStyle.

Referenced by ImplShowHelpWindow(), and Help::UpdatePopover().

void HelpTextWindow::ImplShow ( )
void HelpTextWindow::Paint ( vcl::RenderContext rRenderContext,
const tools::Rectangle  
void HelpTextWindow::RequestHelp ( const HelpEvent rHEvt)

Reimplemented from vcl::Window.

Definition at line 469 of file help.cxx.

void HelpTextWindow::SetHelpArea ( const tools::Rectangle rRect)

Definition at line 66 of file helpwin.hxx.

Referenced by ImplShowHelpWindow().

void HelpTextWindow::SetHelpText ( const OUString &  rHelpText)
void HelpTextWindow::ShowHelp ( bool  bNoDelay)

Member Data Documentation

tools::Rectangle HelpTextWindow::maHelpArea

Definition at line 33 of file helpwin.hxx.

Referenced by GetHelpArea().

OUString HelpTextWindow::maHelpText

Definition at line 37 of file helpwin.hxx.

Referenced by GetHelpText(), GetText(), Paint(), and SetHelpText().

Timer HelpTextWindow::maHideTimer

Definition at line 40 of file helpwin.hxx.

Referenced by dispose(), and HelpTextWindow().

Timer HelpTextWindow::maShowTimer

Definition at line 39 of file helpwin.hxx.

Referenced by dispose(), HelpTextWindow(), and ShowHelp().

tools::Rectangle HelpTextWindow::maTextRect

Definition at line 35 of file helpwin.hxx.

Referenced by CalcOutSize(), Paint(), and SetHelpText().

sal_uInt16 HelpTextWindow::mnHelpWinStyle

Definition at line 42 of file helpwin.hxx.

Referenced by GetWinStyle(), HelpTextWindow(), Paint(), SetHelpText(), and ShowHelp().

QuickHelpFlags HelpTextWindow::mnStyle

Definition at line 43 of file helpwin.hxx.

Referenced by GetStyle(), HelpTextWindow(), Paint(), and SetHelpText().

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