LibreOffice Module vcl (master) 1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
Dialog Class Reference

#include <dialog.hxx>

Inheritance diagram for Dialog:
[legend]
Collaboration diagram for Dialog:
[legend]

Public Types

enum class  InitFlag {
  Default ,
  NoParent
}
 

Public Member Functions

SAL_DLLPRIVATE bool IsInClose () const
 
virtual void doDeferredInit (WinBits nBits) override
 
SAL_DLLPRIVATE void disposeOwnedButtons ()
 
 Dialog (vcl::Window *pParent, WinBits nStyle=WB_STDDIALOG, InitFlag eFlag=InitFlag::Default)
 
virtual ~Dialog () override
 
virtual void dispose () override
 This is intended to be used to clear any locally held references to other Window-subclass objects. More...
 
virtual bool EventNotify (NotifyEvent &rNEvt) override
 
virtual void StateChanged (StateChangedType nStateChange) override
 
virtual void DataChanged (const DataChangedEvent &rDCEvt) override
 
virtual void Command (const CommandEvent &rCEvt) override
 
virtual void PixelInvalidate (const tools::Rectangle *pRectangle) override
 Notification about some rectangle of the output device got invalidated. More...
 
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout) override
 
virtual bool set_property (const OString &rKey, const OUString &rValue) override
 
VclButtonBox * get_action_area ()
 
VclBox * get_content_area ()
 
virtual bool Close () override
 
short Execute ()
 
bool IsInExecute () const
 
bool IsInSyncExecute () const
 
virtual FactoryFunction GetUITestFactory () const override
 
bool StartExecuteAsync (VclAbstractDialog::AsyncContext &rCtx)
 Commence execution of a modal dialog, disposes owner on failure. More...
 
void EndDialog (tools::Long nResult=RET_CANCEL)
 
void GetDrawWindowBorder (sal_Int32 &rLeftBorder, sal_Int32 &rTopBorder, sal_Int32 &rRightBorder, sal_Int32 &rBottomBorder) const
 
void SetModalInputMode (bool bModal)
 
bool IsModalInputMode () const
 
void GrabFocusToFirstControl ()
 
virtual void Resize () override
 
void Activate () override
 
void SetPopupMenuHdl (const Link< const CommandEvent &, bool > &rLink)
 
void SetInstallLOKNotifierHdl (const Link< void *, vcl::ILibreOfficeKitNotifier * > &rLink)
 
void SetLOKTunnelingState (bool bEnabled)
 
void add_button (PushButton *pButton, int nResponse, bool bTransferOwnership)
 
void set_default_response (int nResponse)
 
int get_default_response () const
 
vcl::Window * get_widget_for_response (int nResponse)
 
void DumpAsPropertyTree (tools::JsonWriter &rJsonWriter) override
 Dumps itself and potentially its children to a property tree, to be written easily to JSON. More...
 
- Public Member Functions inherited from SystemWindow
SAL_DLLPRIVATE bool ImplIsInTaskPaneList (vcl::Window *pWin)
 
SAL_DLLPRIVATE bool isDeferredInit () const
 
virtual ~SystemWindow () override
 
virtual void dispose () override
 This is intended to be used to clear any locally held references to other Window-subclass objects. More...
 
virtual bool EventNotify (NotifyEvent &rNEvt) 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 bAllowWindowShrink)
 
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 Size & GetMinOutputSizePixel () const
 
void SetMaxOutputSizePixel (const Size &rSize)
 
const Size & GetMaxOutputSizePixel () const
 
void SetWindowState (std::string_view rStr)
 
OString GetWindowState (vcl::WindowDataMask nMask=vcl::WindowDataMask::All) const
 
void SetMenuBar (MenuBar *pMenuBar)
 
MenuBar * GetMenuBar () 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
 
TaskPaneList * GetTaskPaneList ()
 
void GetWindowState (vcl::WindowData &rData) const
 
virtual void SetText (const OUString &rStr) override
 
virtual OUString GetText () const 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
 
virtual void doDeferredInit (WinBits nBits)
 
VclPtr< VirtualDevice > createScreenshot ()
 
- 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::Window * ImplGetFrameWindow () const
 
weld::Window * GetFrameWeld () const
 
vcl::Window * GetFrameWindow () const
 
SalFrame * ImplGetFrame () const
 
SAL_DLLPRIVATE ImplFrameData * ImplGetFrameData ()
 
vcl::Window * ImplGetWindow () const
 if this is a proxy return the client, otherwise itself More...
 
SAL_DLLPRIVATE ImplWinData * ImplGetWinData () const
 
SAL_DLLPRIVATE vcl::Window * ImplGetClientWindow () const
 
SAL_DLLPRIVATE vcl::Window * ImplGetDlgWindow (sal_uInt16 n, GetDlgWindowType nType, sal_uInt16 nStart=0, sal_uInt16 nEnd=0xFFFF, sal_uInt16 *pIndex=nullptr)
 
SAL_DLLPRIVATE vcl::Window * ImplGetParent () const
 
SAL_DLLPRIVATE vcl::Window * ImplFindWindow (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 WindowImpl * ImplGetWindowImpl () 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 ()
 
SAL_DLLPRIVATE void CompatGetFocus ()
 
SAL_DLLPRIVATE void CompatLoseFocus ()
 
SAL_DLLPRIVATE void CompatStateChanged (StateChangedType nStateChange)
 
SAL_DLLPRIVATE void CompatDataChanged (const DataChangedEvent &rDCEvt)
 
SAL_DLLPRIVATE bool CompatPreNotify (NotifyEvent &rNEvt)
 
SAL_DLLPRIVATE bool CompatNotify (NotifyEvent &rNEvt)
 
void IncModalCount ()
 
void DecModalCount ()
 
 Window (vcl::Window *pParent, WinBits nStyle=0)
 
virtual ~Window () override
 
::OutputDevice const * GetOutDev () const
 
::OutputDevice * GetOutDev ()
 
Color GetBackgroundColor () const
 
const Wallpaper & GetBackground () const
 
bool IsBackground () const
 
const MapMode & GetMapMode () 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)
 
virtual void PrePaint (vcl::RenderContext &rRenderContext)
 
virtual void Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
 
virtual void PostPaint (vcl::RenderContext &rRenderContext)
 
void Erase (vcl::RenderContext &rRenderContext)
 
virtual void Draw (::OutputDevice *pDev, const Point &rPos, SystemTextColorFlags nFlags)
 
virtual void Move ()
 
virtual void Resize ()
 
virtual void Activate ()
 
virtual void Deactivate ()
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual void RequestHelp (const HelpEvent &rHEvt)
 
virtual void Command (const CommandEvent &rCEvt)
 
virtual void Tracking (const TrackingEvent &rTEvt)
 
virtual void StateChanged (StateChangedType nStateChange)
 
virtual void DataChanged (const DataChangedEvent &rDCEvt)
 
virtual bool PreNotify (NotifyEvent &rNEvt)
 
virtual bool EventNotify (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)
 
ImplSVEvent * PostUserEvent (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
 
SystemWindow * GetSystemWindow () 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 InputContext & GetInputContext () const
 
void PostExtTextInputEvent (VclEventId nType, const OUString &rText)
 
void EndExtTextInput ()
 
void SetCursorRect (const tools::Rectangle *pRect=nullptr, tools::Long nExtTextInputWidth=0)
 
const tools::Rectangle * GetCursorRect () 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 Color & GetControlForeground () const
 
bool IsControlForeground () const
 
void ApplyControlForeground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
 
void SetControlBackground ()
 
void SetControlBackground (const Color &rColor)
 
const Color & GetControlBackground () 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::Window * GetParent () const
 
Dialog * GetParentDialog () 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...
 
virtual void PixelInvalidate (const tools::Rectangle *pRectangle)
 Notification about some rectangle of the output device got invalidated. 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::Window > GetFocusedWindow () 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 LocalStartDrag ()
 
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::Cursor * GetCursor () const
 
void SetZoom (const Fraction &rZoom)
 
const Fraction & GetZoom () const
 
bool IsZoom () const
 
tools::Long CalcZoom (tools::Long n) const
 
virtual void SetText (const OUString &rStr)
 
virtual OUString GetText () const
 
virtual OUString GetDisplayText () const
 
virtual const Wallpaper & GetDisplayBackground () 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::Window * GetChild (sal_uInt16 nChild) const
 
vcl::Window * GetWindow (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, Scrollable *pHScrl, Scrollable *pVScrl)
 
virtual const SystemEnvData * GetSystemData () const
 
virtual css::uno::Reference< css::awt::XWindowPeer > GetComponentInterface (bool bCreate=true)
 
void SetComponentInterface (css::uno::Reference< css::awt::XWindowPeer > const &xIFace)
 
void SetUseFrameData (bool bUseFrameData)
 
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::Window > GetParentWithLOKNotifier ()
 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)
 
VCLXWindow * GetWindowPeer () 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...
 
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout)
 
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, std::u16string_view 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)
 
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
 
virtual bool IsStarMath () 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 AllSettings & GetSettings () 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::Font & GetFont () const
 
tools::Long GetTextWidth (const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, vcl::text::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 Color & GetTextColor () const
 
void SetTextFillColor ()
 
void SetTextFillColor (const Color &rColor)
 
Color GetTextFillColor () const
 
bool IsTextFillColor () const
 
void SetTextLineColor ()
 
void SetTextLineColor (const Color &rColor)
 
const Color & GetTextLineColor () const
 
bool IsTextLineColor () const
 
void SetOverlineColor ()
 
void SetOverlineColor (const Color &rColor)
 
const Color & GetOverlineColor () 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::Window * GetAccessibleParentWindow () const
 
sal_uInt16 GetAccessibleChildWindowCount ()
 
vcl::Window * GetAccessibleChildWindow (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::Window * GetAccessibleRelationLabeledBy () const
 
void SetAccessibleRelationLabelFor (vcl::Window *pLabelFor)
 
vcl::Window * GetAccessibleRelationLabelFor () const
 
vcl::Window * GetAccessibleRelationMemberOf () 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 ()
 

Static Public Member Functions

static SAL_DLLPRIVATE vcl::Window * GetDefDialogParent ()
 
- 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 DockingManager * GetDockingManager ()
 
static VclPtr< vcl::Window > SaveFocus ()
 
static void EndSaveFocus (const VclPtr< vcl::Window > &xFocusWin)
 
static VclPtr< vcl::Window > FindLOKWindow (vcl::LOKWindowId nWindowId)
 Find an existing Window based on the LOKWindowId. More...
 
static bool IsLOKWindowsEmpty ()
 check if LOK Window container is empty More...
 

Protected Member Functions

void ImplInitDialog (vcl::Window *pParent, WinBits nStyle, InitFlag eFlag=InitFlag::Default)
 
void ImplLOKNotifier (vcl::Window *pParent)
 Find and set the LOK notifier according to the pParent. More...
 
 Dialog (WindowType nType)
 
 Dialog (vcl::Window *pParent, std::u16string_view rID, const OUString &rUIXMLDescription)
 
virtual void Draw (OutputDevice *pDev, const Point &rPos, SystemTextColorFlags nFlags) override
 
virtual void settingOptimalLayoutSize (Window *pBox) override
 
void set_action_area (VclButtonBox *pBox)
 
void set_content_area (VclBox *pBox)
 
- Protected Member Functions inherited from SystemWindow
 SystemWindow (WindowType nType, const char *pIdleDebugName)
 
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 SetWindowState (const vcl::WindowData &rData)
 
virtual void settingOptimalLayoutSize (Window *pBox)
 
SAL_DLLPRIVATE void DoInitialLayout ()
 
- Protected Member Functions inherited from vcl::Window
virtual void dispose () override
 This is intended to be used to clear any locally held references to other Window-subclass objects. More...
 
SAL_DLLPRIVATE void ImplInit (vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
 
SAL_DLLPRIVATE Point ImplOutputToFrame (const Point &rPos)
 
SAL_DLLPRIVATE void ImplInvalidateParentFrameRegion (const 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::Window * ImplGetBorderWindow () 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 ()
 
virtual void ApplySettings (vcl::RenderContext &rRenderContext)
 
SAL_DLLPRIVATE float approximate_char_width () const
 
SAL_DLLPRIVATE vcl::Window * getLegacyNonLayoutAccessibleRelationMemberOf () const
 
SAL_DLLPRIVATE vcl::Window * getLegacyNonLayoutAccessibleRelationLabeledBy () const
 
SAL_DLLPRIVATE vcl::Window * getLegacyNonLayoutAccessibleRelationLabelFor () const
 
virtual vcl::Window * getAccessibleRelationLabelFor () 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 ()
 
virtual void dispose ()
 

Private Member Functions

SAL_DLLPRIVATE void RemoveFromDlgList ()
 
SAL_DLLPRIVATE void ImplInitDialogData ()
 
SAL_DLLPRIVATE void ImplInitSettings ()
 
SAL_DLLPRIVATE VclPtr< vcl::Window > AddBorderWindow (vcl::Window *pParent, WinBits nBits)
 
virtual void ApplySettings (vcl::RenderContext &rRenderContext) override
 
SAL_DLLPRIVATE Dialog (const Dialog &)=delete
 
SAL_DLLPRIVATE Dialog & operator= (const Dialog &)=delete
 
 DECL_DLLPRIVATE_LINK (ImplAsyncCloseHdl, void *, void)
 
 DECL_DLLPRIVATE_LINK (ResponseHdl, Button *, void)
 
bool ImplStartExecute ()
 
void ImplSetModalInputMode (bool bModal)
 
vcl::Window * GetFirstControlForFocus ()
 

Static Private Member Functions

static SAL_DLLPRIVATE vcl::Window * GetDefaultParent (WinBits nStyle)
 
static void ImplEndExecuteModal ()
 

Private Attributes

std::unique_ptr< DialogImpl > mpDialogImpl
 
tools::Long mnMousePositioned
 
bool mbInExecute
 
bool mbInSyncExecute
 
bool mbInClose
 
bool mbModalMode
 
InitFlag mnInitFlag
 
VclPtr< VclButtonBox > mpActionArea
 
VclPtr< VclBox > mpContentArea
 

Friends

class VclBuilder
 
class SalInstanceBuilder
 

Additional Inherited Members

- Protected Attributes inherited from SystemWindow
bool mbIsDeferredInit
 
VclPtr< vcl::Window > mpDialogParent
 
- Protected Attributes inherited from VclBuilderContainer
std::unique_ptr< VclBuilder > m_pUIBuilder
 

Detailed Description

Definition at line 40 of file dialog.hxx.

Member Enumeration Documentation

◆ InitFlag

enum class Dialog::InitFlag
strong
Enumerator
Default 

Use given parent or get a default one using GetDefaultParent(...)

NoParent 

No Parent.

Definition at line 43 of file dialog.hxx.

Constructor & Destructor Documentation

◆ Dialog() [1/4]

SAL_DLLPRIVATE Dialog::Dialog ( const Dialog &  )
privatedelete

◆ Dialog() [2/4]

Dialog::Dialog ( WindowType  nType)
explicitprotected

Definition at line 544 of file dialog.cxx.

References Default, ImplInitDialogData(), and nType.

◆ Dialog() [3/4]

Dialog::Dialog ( vcl::Window *  pParent,
std::u16string_view  rID,
const OUString &  rUIXMLDescription 
)
explicitprotected

Definition at line 574 of file dialog.cxx.

References Default, DIALOG, ImplInitDialogData(), ImplLOKNotifier(), SystemWindow::loadUI(), and OUStringToOString().

◆ Dialog() [4/4]

Dialog::Dialog ( vcl::Window *  pParent,
WinBits  nStyle = WB_STDDIALOG,
InitFlag  eFlag = InitFlag::Default 
)
explicit

Definition at line 583 of file dialog.cxx.

References DIALOG, ImplInitDialog(), ImplInitDialogData(), and ImplLOKNotifier().

◆ ~Dialog()

Dialog::~Dialog ( )
overridevirtual

Definition at line 616 of file dialog.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

◆ Activate()

void Dialog::Activate ( )
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1608 of file dialog.cxx.

References vcl::Window::Activate(), comphelper::getProcessComponentContext(), vcl::Window::GetType(), and MODELESSDIALOG.

◆ add_button()

void Dialog::add_button ( PushButton *  pButton,
int  nResponse,
bool  bTransferOwnership 
)

Definition at line 1439 of file dialog.cxx.

References CANCELBUTTON, Button::GetClickHdl(), vcl::Window::GetHelpId(), vcl::Window::GetType(), HELPBUTTON, Link< typename Arg, typename Ret >::IsSet(), LINK, mpDialogImpl, OKBUTTON, PUSHBUTTON, RET_CANCEL, RET_CLOSE, RET_HELP, RET_OK, SAL_WARN, and Button::SetClickHdl().

Referenced by MessageDialog::create_message_area(), and VclBuilder::set_response().

◆ AddBorderWindow()

VclPtr< vcl::Window > Dialog::AddBorderWindow ( vcl::Window *  pParent,
WinBits  nBits 
)
private

Definition at line 433 of file dialog.cxx.

References Frame, vcl::Window::ImplInit(), vcl::Window::mpWindowImpl, and WB_BORDER.

Referenced by ImplInitDialog().

◆ ApplySettings()

void Dialog::ApplySettings ( vcl::RenderContext &  rRenderContext)
overrideprivatevirtual

Reimplemented from vcl::Window.

Definition at line 497 of file dialog.cxx.

References BackgroundDialog, vcl::Window::EnableChildTransparentMode(), vcl::Window::GetControlBackground(), vcl::Window::GetSettings(), vcl::Window::IsControlBackground(), OutputDevice::IsNativeControlSupported(), vcl::Window::mpWindowImpl, OutputDevice::SetBackground(), vcl::Window::SetBackground(), and WindowBackground.

◆ Close()

bool Dialog::Close ( )
overridevirtual

Reimplemented from SystemWindow.

Definition at line 844 of file dialog.cxx.

References vcl::Window::CallEventListeners(), Button::Click(), SystemWindow::Close(), EndDialog(), get_widget_for_response(), Button::GetClickHdl(), vcl::Window::GetStyle(), ImplGetCancelButton(), ImplGetOKButton(), vcl::Window::IsCreatedWithToolkit(), VclReferenceBase::isDisposed(), IsInExecute(), Link< typename Arg, typename Ret >::IsSet(), mbInClose, mpDialogImpl, vcl::Window::mpWindowImpl, RET_CANCEL, WB_CLOSEABLE, and WindowClose.

Referenced by OKButton::Click(), CancelButton::Click(), and vcl::RoadmapWizard::Finish().

◆ Command()

void Dialog::Command ( const CommandEvent &  rCEvt)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1622 of file dialog.cxx.

References vcl::Window::Command(), and mpDialogImpl.

◆ DataChanged()

void Dialog::DataChanged ( const DataChangedEvent &  rDCEvt)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 832 of file dialog.cxx.

References vcl::Window::DataChanged(), DataChangedEvent::GetFlags(), DataChangedEvent::GetType(), ImplInitSettings(), vcl::Window::Invalidate(), SETTINGS, and STYLE.

◆ DECL_DLLPRIVATE_LINK() [1/2]

Dialog::DECL_DLLPRIVATE_LINK ( ImplAsyncCloseHdl  ,
void *  ,
void   
)
private

◆ DECL_DLLPRIVATE_LINK() [2/2]

Dialog::DECL_DLLPRIVATE_LINK ( ResponseHdl  ,
Button *  ,
void   
)
private

◆ dispose()

void Dialog::dispose ( void  )
overridevirtual

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

Reimplemented from SystemWindow.

Reimplemented in MessageDialog, and vcl::RoadmapWizard.

Definition at line 621 of file dialog.cxx.

References VclPtr< reference_type >::clear(), SystemWindow::dispose(), UITestLogger::getInstance(), vcl::Window::GetLOKNotifier(), vcl::Window::GetLOKWindowId(), comphelper::getProcessComponentContext(), comphelper::LibreOfficeKit::isActive(), UITestLogger::log(), mpActionArea, mpContentArea, mpDialogImpl, vcl::Window::ReleaseLOKNotifier(), RemoveFromDlgList(), and u.

Referenced by MessageDialog::dispose(), and vcl::RoadmapWizard::dispose().

◆ disposeOwnedButtons()

void Dialog::disposeOwnedButtons ( )

Definition at line 381 of file dialog.cxx.

References VclPtr< reference_type >::disposeAndClear(), and mpDialogImpl.

Referenced by MessageDialog::dispose().

◆ doDeferredInit()

void Dialog::doDeferredInit ( WinBits  nBits)
overridevirtual

Reimplemented from SystemWindow.

Definition at line 566 of file dialog.cxx.

References ImplInitDialog(), SystemWindow::mbIsDeferredInit, mnInitFlag, SystemWindow::mpDialogParent, and WB_BORDER.

◆ Draw()

void Dialog::Draw ( OutputDevice *  pDev,
const Point &  rPos,
SystemTextColorFlags  nFlags 
)
overrideprotectedvirtual

Definition at line 1348 of file dialog.cxx.

References OutputDevice::DrawBitmapEx(), OutputDevice::DrawRect(), vcl::Window::GetBackground(), Wallpaper::GetBitmap(), Wallpaper::GetColor(), vcl::Window::GetSizePixel(), vcl::Window::GetStyle(), SystemWindow::GetText(), Size::Height(), ImplInitSettings(), Wallpaper::IsBitmap(), OutputDevice::LogicToPixel(), Overlap, Point, OutputDevice::Pop(), OutputDevice::Push(), OutputDevice::SetFillColor(), OutputDevice::SetLineColor(), OutputDevice::SetMapMode(), WB_BORDER, WB_NOBORDER, WB_STDWORK, and Size::Width().

◆ DumpAsPropertyTree()

void Dialog::DumpAsPropertyTree ( tools::JsonWriter &  rJsonWriter)
overridevirtual

Dumps itself and potentially its children to a property tree, to be written easily to JSON.

Reimplemented from vcl::Window.

Definition at line 1689 of file dialog.cxx.

References vcl::Window::DumpAsPropertyTree(), get_action_area(), vcl::Window::get_id(), GetFirstControlForFocus(), vcl::Window::GetHelpId(), SystemWindow::GetText(), mpDialogImpl, tools::JsonWriter::put(), tools::JsonWriter::startArray(), and tools::JsonWriter::startStruct().

◆ EndDialog()

void Dialog::EndDialog ( tools::Long  nResult = RET_CANCEL)

Definition at line 1119 of file dialog.cxx.

References vcl::Window::GetLOKNotifier(), vcl::Window::GetLOKWindowId(), vcl::Window::GetType(), vcl::Window::GrabFocus(), vcl::Window::Hide(), ImplEndExecuteModal(), vcl::Window::ImplGetFrame(), vcl::Window::ImplGetFrameWindow(), vcl::Window::ImplGetParent(), ImplGetSVData(), comphelper::LibreOfficeKit::isActive(), VclReferenceBase::isDisposed(), mbInExecute, MODELESSDIALOG, mpDialogImpl, ImplSVWinData::mpExecuteDialogs, ImplSVData::mpWinData, vcl::Window::ReleaseLOKNotifier(), RemoveFromDlgList(), and SetModalInputMode().

Referenced by OKButton::Click(), Close(), and vcl::RoadmapWizard::Finish().

◆ EventNotify()

bool Dialog::EventNotify ( NotifyEvent &  rNEvt)
overridevirtual

Reimplemented from SystemWindow.

Reimplemented in vcl::RoadmapWizard.

Definition at line 656 of file dialog.cxx.

References SystemWindow::EventNotify(), vcl::KeyCode::GetCode(), GETFOCUS, KeyEvent::GetKeyCode(), NotifyEvent::GetKeyEvent(), vcl::Window::GetStyle(), NotifyEvent::GetType(), ImplGetCancelButton(), ImplGetOKButton(), ImplMouseAutoPos(), ImplSetModalInputMode(), KEY_ESCAPE, KEYINPUT, LINK, mbInExecute, mbModalMode, mnMousePositioned, vcl::Window::PostUserEvent(), and WB_CLOSEABLE.

Referenced by vcl::RoadmapWizard::EventNotify().

◆ Execute()

short Dialog::Execute ( )

Definition at line 1048 of file dialog.cxx.

References VclPtr< reference_type >::clear(), ImplEndExecuteModal(), ImplStartExecute(), VclReferenceBase::isDisposed(), Application::IsQuit(), mbInExecute, mbInSyncExecute, mpDialogImpl, SystemWindow::mpDialogParent, SAL_WARN, and Application::Yield().

◆ get_action_area()

VclButtonBox * Dialog::get_action_area ( )
inline

Definition at line 118 of file dialog.hxx.

Referenced by MessageDialog::create_message_area(), and DumpAsPropertyTree().

◆ get_content_area()

VclBox * Dialog::get_content_area ( )
inline

Definition at line 119 of file dialog.hxx.

Referenced by MessageDialog::create_message_area(), and SalInstanceWindow::help().

◆ get_default_response()

int Dialog::get_default_response ( ) const

Definition at line 1509 of file dialog.cxx.

References a, CANCELBUTTON, FirstChild, vcl::Window::GetWindow(), HELPBUTTON, mpActionArea, mpDialogImpl, Next, OKBUTTON, RET_CANCEL, RET_HELP, RET_OK, and WB_DEFBUTTON.

Referenced by MessageDialog::create_message_area().

◆ get_widget_for_response()

vcl::Window * Dialog::get_widget_for_response ( int  nResponse)

Definition at line 1470 of file dialog.cxx.

References a, CANCELBUTTON, FirstChild, vcl::Window::GetWindow(), HELPBUTTON, mpActionArea, mpDialogImpl, Next, OKBUTTON, RET_CANCEL, RET_HELP, and RET_OK.

Referenced by Close().

◆ GetDefaultParent()

vcl::Window * Dialog::GetDefaultParent ( WinBits  nStyle)
staticprivate

Definition at line 408 of file dialog.cxx.

References GetDefDialogParent(), ImplGetSVData(), vcl::Window::IsInModalMode(), vcl::Window::IsInputEnabled(), ImplSVData::maFrameData, ImplSVFrameData::mpAppWin, ImplSVWinData::mpExecuteDialogs, ImplSVData::mpWinData, and WB_SYSTEMWINDOW.

Referenced by ImplInitDialog().

◆ GetDefDialogParent()

vcl::Window * Dialog::GetDefDialogParent ( )
static

Definition at line 1485 of file svapp.cxx.

References ImplGetSVData(), vcl::Window::ImplGetWindow(), vcl::Window::IsMenuFloatingWindow(), vcl::Window::IsTopWindow(), ImplSVData::maFrameData, ImplSVFrameData::mpActiveApplicationFrame, ImplSVFrameData::mpFirstFrame, ImplSVWinData::mpFocusWin, ImplSVData::mpWinData, vcl::Window::mpWindowImpl, and WB_INTROWIN.

Referenced by GetDefaultParent(), and Application::GetDefDialogParent().

◆ GetDrawWindowBorder()

void Dialog::GetDrawWindowBorder ( sal_Int32 &  rLeftBorder,
sal_Int32 &  rTopBorder,
sal_Int32 &  rRightBorder,
sal_Int32 &  rBottomBorder 
) const

Definition at line 1342 of file dialog.cxx.

References Overlap, WB_BORDER, and WB_STDWORK.

◆ GetFirstControlForFocus()

vcl::Window * Dialog::GetFirstControlForFocus ( )
private

Definition at line 1307 of file dialog.cxx.

References First, vcl::Window::GetStyle(), vcl::Window::HasFocus(), vcl::Window::ImplFindDlgCtrlWindow(), vcl::Window::ImplGetDlgWindow(), vcl::Window::ImplGetFirstOverlapWindow(), isEnabledInLayout(), vcl::Window::IsInputEnabled(), isVisibleInLayout(), vcl::Window::mpWindowImpl, and WB_TABSTOP.

Referenced by DumpAsPropertyTree(), and GrabFocusToFirstControl().

◆ GetUITestFactory()

FactoryFunction Dialog::GetUITestFactory ( ) const
overridevirtual

Reimplemented from vcl::Window.

Reimplemented in vcl::RoadmapWizard.

Definition at line 1416 of file dialog.cxx.

References DialogUIObject::create().

◆ GrabFocusToFirstControl()

void Dialog::GrabFocusToFirstControl ( )

Definition at line 1335 of file dialog.cxx.

References GetFirstControlForFocus(), vcl::Window::ImplControlFocus(), and Init.

Referenced by StateChanged().

◆ ImplEndExecuteModal()

void Dialog::ImplEndExecuteModal ( )
staticprivate

Definition at line 1042 of file dialog.cxx.

References ImplGetSVData(), ImplSVData::maAppData, and ImplSVAppData::mnModalMode.

Referenced by EndDialog(), and Execute().

◆ ImplInitDialog()

void Dialog::ImplInitDialog ( vcl::Window *  pParent,
WinBits  nStyle,
InitFlag  eFlag = InitFlag::Default 
)
protected

Definition at line 445 of file dialog.cxx.

References AddBorderWindow(), DIALOG, GetDefaultParent(), Application::GetSystemWindowMode(), GrabFocus, vcl::Window::ImplInit(), ImplInitSettings(), vcl::Window::mpWindowImpl, NOAUTOMODE, NoParent, Overlap, vcl::Window::SetActivateMode(), WB_ALLOWMENUBAR, WB_BORDER, WB_CLOSEABLE, WB_DIALOGCONTROL, WB_MOVEABLE, WB_NOBORDER, WB_NODIALOGCONTROL, WB_SIZEABLE, WB_STANDALONE, and WB_SYSTEMWINDOW.

Referenced by Dialog(), and doDeferredInit().

◆ ImplInitDialogData()

void Dialog::ImplInitDialogData ( )
private

Definition at line 387 of file dialog.cxx.

References VclPtr< reference_type >::clear(), mbInClose, mbInExecute, mbInSyncExecute, mbModalMode, mnMousePositioned, mpActionArea, mpContentArea, mpDialogImpl, and vcl::Window::mpWindowImpl.

Referenced by Dialog().

◆ ImplInitSettings()

void Dialog::ImplInitSettings ( )
private

Definition at line 517 of file dialog.cxx.

References BackgroundDialog, vcl::Window::EnableChildTransparentMode(), vcl::Window::GetControlBackground(), vcl::Window::GetSettings(), vcl::Window::IsControlBackground(), vcl::Window::IsNativeControlSupported(), vcl::Window::mpWindowImpl, vcl::Window::SetBackground(), and WindowBackground.

Referenced by DataChanged(), Draw(), ImplInitDialog(), and StateChanged().

◆ ImplLOKNotifier()

void Dialog::ImplLOKNotifier ( vcl::Window *  pParent)
protected

Find and set the LOK notifier according to the pParent.

Definition at line 533 of file dialog.cxx.

References vcl::Window::GetParentWithLOKNotifier(), comphelper::LibreOfficeKit::isActive(), and vcl::Window::SetLOKNotifier().

Referenced by Dialog().

◆ ImplSetModalInputMode()

void Dialog::ImplSetModalInputMode ( bool  bModal)
private

Definition at line 1247 of file dialog.cxx.

References vcl::Window::DecModalCount(), vcl::Window::EnableInput(), vcl::Window::GetParent(), ImplGetSVData(), ImplSetModalInputMode(), vcl::Window::IncModalCount(), IsModalInputMode(), vcl::Window::IsWindowOrChild(), mbModalMode, SystemWindow::mpDialogParent, ImplSVWinData::mpExecuteDialogs, ImplSVData::mpWinData, and vcl::Window::mpWindowImpl.

Referenced by EventNotify(), ImplSetModalInputMode(), and SetModalInputMode().

◆ ImplStartExecute()

bool Dialog::ImplStartExecute ( )
private

Definition at line 906 of file dialog.cxx.

References Cancel, vcl::Window::EnableInput(), vcl::Window::EndTracking(), Fatal, ForegroundTask, vcl::Window::get_id(), Application::GetDialogCancelMode(), UITestLogger::getInstance(), vcl::Window::GetLOKNotifier(), vcl::Window::GetLOKWindowId(), vcl::Window::GetParent(), comphelper::getProcessComponentContext(), vcl::Window::GetSizePixel(), vcl::Window::GetType(), vcl::Window::ImplAdjustNWFSizes(), ImplGetDialogText(), vcl::Window::ImplGetFirstOverlapWindow(), ImplGetSVData(), comphelper::LibreOfficeKit::isActive(), IsInExecute(), vcl::Window::IsInModalMode(), vcl::Window::IsInputEnabled(), IsInSyncExecute(), vcl::Window::IsReallyVisible(), SalInstance::IsRunningUnitTest(), UITestLogger::log(), LOKSilent, ImplSVData::maAppData, mbInExecute, ImplSVAppData::mnModalMode, MODELESSDIALOG, ImplSVWinData::mpCaptureWin, mpDialogImpl, ImplSVWinData::mpExecuteDialogs, ImplSVWinData::mpTrackWin, ImplSVData::mpWinData, NONE, Off, vcl::Window::ReleaseMouse(), SAL_INFO, SAL_WARN, SAL_WARN_IF, VclBuilderContainer::setDeferredProperties(), vcl::Window::SetLOKNotifier(), SetModalInputMode(), vcl::Window::Show(), Silent, and toString().

Referenced by Execute(), and StartExecuteAsync().

◆ IsInClose()

SAL_DLLPRIVATE bool Dialog::IsInClose ( ) const
inline

Definition at line 87 of file dialog.hxx.

Referenced by OKButton::Click(), CancelButton::Click(), queue_resize(), and vcl::RoadmapWizard::queue_resize().

◆ IsInExecute()

bool Dialog::IsInExecute ( ) const
inline

Definition at line 124 of file dialog.hxx.

Referenced by OKButton::Click(), Close(), vcl::RoadmapWizard::Finish(), and ImplStartExecute().

◆ IsInSyncExecute()

bool Dialog::IsInSyncExecute ( ) const
inline

Definition at line 126 of file dialog.hxx.

Referenced by ImplStartExecute().

◆ IsModalInputMode()

bool Dialog::IsModalInputMode ( ) const
inline

Definition at line 150 of file dialog.hxx.

Referenced by DialogUIObject::get_state(), and ImplSetModalInputMode().

◆ operator=()

SAL_DLLPRIVATE Dialog & Dialog::operator= ( const Dialog &  )
privatedelete

◆ PixelInvalidate()

void Dialog::PixelInvalidate ( const tools::Rectangle *  pRectangle)
overridevirtual

Notification about some rectangle of the output device got invalidated.

Used for the dialogs and floating windows (e.g. context menu, popup).

Parameters
pRectangleIf 0, that means the whole area, otherwise the area in pixel coordinates.

Reimplemented from vcl::Window.

Definition at line 400 of file dialog.cxx.

References mpDialogImpl.

◆ queue_resize()

void Dialog::queue_resize ( StateChangedType  eReason = StateChangedType::Layout)
overridevirtual

Reimplemented from SystemWindow.

Reimplemented in vcl::RoadmapWizard.

Definition at line 1383 of file dialog.cxx.

References IsInClose(), and SystemWindow::queue_resize().

◆ RemoveFromDlgList()

void Dialog::RemoveFromDlgList ( )
private

Definition at line 1110 of file dialog.cxx.

References ImplGetSVData(), ImplSVWinData::mpExecuteDialogs, and ImplSVData::mpWinData.

Referenced by dispose(), and EndDialog().

◆ Resize()

void Dialog::Resize ( )
overridevirtual

Reimplemented from SystemWindow.

Reimplemented in vcl::RoadmapWizard.

Definition at line 1390 of file dialog.cxx.

References vcl::Window::GetLOKNotifier(), vcl::Window::GetLOKWindowId(), vcl::Window::GetSizePixel(), comphelper::LibreOfficeKit::isDialogPainting(), mpDialogImpl, SystemWindow::Resize(), and toString().

Referenced by vcl::RoadmapWizard::Resize().

◆ set_action_area()

void Dialog::set_action_area ( VclButtonBox *  pBox)
protected

Definition at line 592 of file dialog.cxx.

References DialogStyle::action_area_border, StyleSettings::GetDialogStyle(), vcl::Window::GetSettings(), AllSettings::GetStyleSettings(), mpActionArea, VclPtr< reference_type >::set(), and vcl::Window::set_border_width().

Referenced by MessageDialog::create_owned_areas().

◆ set_content_area()

void Dialog::set_content_area ( VclBox *  pBox)
protected

Definition at line 603 of file dialog.cxx.

References mpContentArea, and VclPtr< reference_type >::set().

Referenced by MessageDialog::create_owned_areas().

◆ set_default_response()

void Dialog::set_default_response ( int  nResponse)

Definition at line 1549 of file dialog.cxx.

References a, CANCELBUTTON, FirstChild, vcl::Window::GetWindow(), HELPBUTTON, mpActionArea, mpDialogImpl, Next, OKBUTTON, RET_CANCEL, RET_HELP, RET_OK, and WB_DEFBUTTON.

Referenced by MessageDialog::create_message_area().

◆ set_property()

bool Dialog::set_property ( const OString &  rKey,
const OUString &  rValue 
)
overridevirtual

Reimplemented from vcl::Window.

Reimplemented in MessageDialog.

Definition at line 1407 of file dialog.cxx.

References vcl::Window::set_border_width(), and vcl::Window::set_property().

Referenced by MessageDialog::set_property().

◆ SetInstallLOKNotifierHdl()

void Dialog::SetInstallLOKNotifierHdl ( const Link< void *, vcl::ILibreOfficeKitNotifier * > &  rLink)

Definition at line 745 of file dialog.cxx.

References mpDialogImpl.

◆ SetLOKTunnelingState()

void Dialog::SetLOKTunnelingState ( bool  bEnabled)

Definition at line 750 of file dialog.cxx.

References mpDialogImpl.

◆ SetModalInputMode()

void Dialog::SetModalInputMode ( bool  bModal)

Definition at line 1231 of file dialog.cxx.

References vcl::Window::GetParent(), vcl::Window::ImplGetFrame(), ImplSetModalInputMode(), mbModalMode, SalFrame::NotifyModalHierarchy(), and SalFrame::SetModal().

Referenced by EndDialog(), and ImplStartExecute().

◆ SetPopupMenuHdl()

void Dialog::SetPopupMenuHdl ( const Link< const CommandEvent &, bool > &  rLink)

Definition at line 740 of file dialog.cxx.

References mpDialogImpl.

◆ settingOptimalLayoutSize()

void Dialog::settingOptimalLayoutSize ( Window *  pBox)
overrideprotectedvirtual

Reimplemented from SystemWindow.

Definition at line 608 of file dialog.cxx.

References DialogStyle::content_area_border, StyleSettings::GetDialogStyle(), vcl::Window::GetSettings(), AllSettings::GetStyleSettings(), and vcl::Window::set_border_width().

◆ StartExecuteAsync()

bool Dialog::StartExecuteAsync ( VclAbstractDialog::AsyncContext &  rCtx)

Commence execution of a modal dialog, disposes owner on failure.

Definition at line 1093 of file dialog.cxx.

References VclPtr< reference_type >::disposeAndClear(), vcl::Window::GetType(), ImplStartExecute(), MODELESSDIALOG, mpDialogImpl, VclAbstractDialog::AsyncContext::mxOwner, VclAbstractDialog::AsyncContext::mxOwnerDialogController, and VclAbstractDialog::AsyncContext::mxOwnerSelf.

◆ StateChanged()

void Dialog::StateChanged ( StateChangedType  nStateChange)
overridevirtual

Reimplemented from vcl::Window.

Reimplemented in vcl::RoadmapWizard, and MessageDialog.

Definition at line 755 of file dialog.cxx.

References ControlBackground, SystemWindow::DoInitialLayout(), vcl::Window::GetLOKNotifier(), vcl::Window::GetLOKWindowId(), vcl::Window::GetSizePixel(), vcl::Window::GetStyle(), SystemWindow::GetText(), GrabFocusToFirstControl(), vcl::Window::HasChildPathFocus(), vcl::Window::HasFocus(), vcl::Window::ImplGetBorderWindow(), ImplGetCancelButton(), ImplGetOKButton(), ImplInitSettings(), ImplMouseAutoPos(), InitShow, vcl::Window::Invalidate(), comphelper::LibreOfficeKit::isActive(), vcl::Window::IsVisible(), mbModalMode, mpDialogImpl, nType, vcl::Window::SetLOKNotifier(), vcl::Window::StateChanged(), Text, toString(), Visible, and WB_CLOSEABLE.

Referenced by vcl::RoadmapWizard::StateChanged(), and MessageDialog::StateChanged().

Friends And Related Function Documentation

◆ SalInstanceBuilder

friend class SalInstanceBuilder
friend

Definition at line 101 of file dialog.hxx.

◆ VclBuilder

friend class VclBuilder
friend

Definition at line 100 of file dialog.hxx.

Member Data Documentation

◆ mbInClose

bool Dialog::mbInClose
private

Definition at line 57 of file dialog.hxx.

Referenced by Close(), and ImplInitDialogData().

◆ mbInExecute

bool Dialog::mbInExecute
private

Definition at line 55 of file dialog.hxx.

Referenced by EndDialog(), EventNotify(), Execute(), ImplInitDialogData(), and ImplStartExecute().

◆ mbInSyncExecute

bool Dialog::mbInSyncExecute
private

Definition at line 56 of file dialog.hxx.

Referenced by Execute(), and ImplInitDialogData().

◆ mbModalMode

bool Dialog::mbModalMode
private

Definition at line 58 of file dialog.hxx.

Referenced by EventNotify(), ImplInitDialogData(), ImplSetModalInputMode(), SetModalInputMode(), and StateChanged().

◆ mnInitFlag

InitFlag Dialog::mnInitFlag
private

Definition at line 59 of file dialog.hxx.

Referenced by doDeferredInit().

◆ mnMousePositioned

tools::Long Dialog::mnMousePositioned
private

Definition at line 54 of file dialog.hxx.

Referenced by EventNotify(), and ImplInitDialogData().

◆ mpActionArea

VclPtr<VclButtonBox> Dialog::mpActionArea
private

Definition at line 61 of file dialog.hxx.

Referenced by dispose(), get_default_response(), get_widget_for_response(), ImplInitDialogData(), set_action_area(), and set_default_response().

◆ mpContentArea

VclPtr<VclBox> Dialog::mpContentArea
private

Definition at line 62 of file dialog.hxx.

Referenced by dispose(), ImplInitDialogData(), and set_content_area().

◆ mpDialogImpl

std::unique_ptr<DialogImpl> Dialog::mpDialogImpl
private

Definition at line 53 of file dialog.hxx.

Referenced by add_button(), Close(), Command(), dispose(), disposeOwnedButtons(), DumpAsPropertyTree(), EndDialog(), Execute(), get_default_response(), get_widget_for_response(), ImplInitDialogData(), ImplStartExecute(), PixelInvalidate(), Resize(), set_default_response(), SetInstallLOKNotifierHdl(), SetLOKTunnelingState(), SetPopupMenuHdl(), StartExecuteAsync(), and StateChanged().

The documentation for this class was generated from the following files:
Generated on Thu Sep 29 2022 01:07:34 for LibreOffice Module vcl (master) by doxygen 1.9.3