wizard for a roadmap More...

#include <wizdlg.hxx>

Inheritance diagram for vcl::RoadmapWizard:

Collaboration diagram for vcl::RoadmapWizard:

Classes
class	AccessGuard

Public Member Functions
	RoadmapWizard (vcl::Window *pParent, WinBits nStyle=WB_STDDIALOG, InitFlag eFlag=InitFlag::Default)

virtual	~RoadmapWizard () override

virtual void	dispose () override
	This is intended to be used to clear any locally held references to other Window-subclass objects. More...

virtual void	Resize () override

virtual void	StateChanged (StateChangedType nStateChange) override

virtual bool	EventNotify (NotifyEvent &rNEvt) override

void	ActivatePage ()

virtual void	queue_resize (StateChangedType eReason=StateChangedType::Layout) override

bool	ShowPage (sal_uInt16 nLevel)

bool	Finish (long nResult=0)

sal_uInt16	GetCurLevel () const

void	AddPage (TabPage *pPage)

void	RemovePage (TabPage *pPage)

void	SetPage (sal_uInt16 nLevel, TabPage *pPage)

TabPage *	GetPage (sal_uInt16 nLevel) const

void	AddButton (Button *pButton, long nOffset=0)

void	RemoveButton (Button *pButton)

void	SetPageSizePixel (const Size &rSize)

const Size &	GetPageSizePixel () const

void	enableButtons (WizardButtonFlags _nWizardButtonFlags, bool _bEnable)
	enable (or disable) buttons More...

bool	canAdvance () const
	determines whether there is a next state to which we can advance More...

void	SetRoadmapHelpId (const OString &_rId)

void	InsertRoadmapItem (int nIndex, const OUString &rLabel, int nId, bool bEnabled)

void	DeleteRoadmapItems ()

int	GetCurrentRoadmapItemID () const

void	SelectRoadmapItemByID (int nId)

void	SetItemSelectHdl (const Link< LinkParamNone *, void > &_rHdl)

void	ShowRoadmap (bool bShow)

FactoryFunction	GetUITestFactory () const override

void	suspendTraveling (AccessGuard)

void	resumeTraveling (AccessGuard)

bool	isTravelingSuspended () const

Public Member Functions inherited from Dialog
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	DataChanged (const DataChangedEvent &rDCEvt) override

virtual void	Command (const CommandEvent &rCEvt) 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

bool	StartExecuteAsync (VclAbstractDialog::AsyncContext &rCtx)
	Commence execution of a modal dialog, disposes owner on failure. More...

void	EndDialog (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 ()

void	Activate () override

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

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

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)

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 void	TitleButtonClick (TitleButton nButton)

virtual void	Resizing (Size &rSize)

virtual Size	GetOptimalSize () const 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	RollUp ()

void	RollDown ()

bool	IsRollUp () const

void	SetRollUpOutputSizePixel (const Size &rSize)

const Size &	GetRollUpOutputSizePixel () const

void	SetMinOutputSizePixel (const Size &rSize)

const Size &	GetMinOutputSizePixel () const

void	SetMaxOutputSizePixel (const Size &rSize)

const Size &	GetMaxOutputSizePixel () const

void	SetWindowState (const OString &rStr)

OString	GetWindowState (WindowStateMask nMask=WindowStateMask::All) const

void	SetMenuBar (MenuBar *pMenuBar)

MenuBar *	GetMenuBar () const

void	SetMenuBarMode (MenuBarMode nMode)

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	GetWindowStateData (WindowStateData &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)

void	SetCloseHdl (const Link< SystemWindow &, void > &rLink)

const Link< SystemWindow &, void > &	GetCloseHdl () const

SAL_DLLPRIVATE bool	hasPendingLayout () const

void	createScreenshot (VirtualDevice &rOutput)

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 (long nX, long nY, long nWidth, long nHeight, PosSizeFlags nFlags)

SAL_DLLPRIVATE void	ImplCallResize ()

SAL_DLLPRIVATE void	ImplCallMove ()

void	IncModalCount ()

void	DecModalCount ()

virtual vcl::Region	GetActiveClipRegion () const override

virtual vcl::Region	GetOutputBoundsClipRegion () const override

bool	HasMirroredGraphics () const override

	Window (vcl::Window *pParent, WinBits nStyle=0)

virtual	~Window () override

::OutputDevice const *	GetOutDev () const

::OutputDevice *	GetOutDev ()

Color	GetBackgroundColor () const override

size_t	GetSyncCount () const override

virtual void	EnableRTL (bool bEnable=true) override

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	Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)

void	Erase (vcl::RenderContext &rRenderContext)

virtual void	Draw (::OutputDevice *pDev, const Point &rPos, DrawFlags nFlags)

virtual void	Move ()

virtual void	Deactivate ()

virtual void	GetFocus ()

virtual void	LoseFocus ()

virtual void	RequestHelp (const HelpEvent &rHEvt)

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)

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

bool	IsDisposed () 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

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, long nExtTextInputWidth=0)

const tools::Rectangle *	GetCursorRect () const

long	GetCursorExtTextInputWidth () const

void	SetCompositionCharRect (const tools::Rectangle *pRect, long nCompositionLength, bool bVertical=false)

virtual void	SetSettings (const AllSettings &rSettings) override

void	SetSettings (const AllSettings &rSettings, bool bChild)

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)

long	GetDrawPixel (::OutputDevice const *pDev, 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...

void	AlwaysDisableInput (bool bAlways, bool bChild=true)
	Override `EnableInput`, counterpart to AlwaysEnableInput. More...

void	SetCallHandlersOnInputDisabled (bool bCall)
	usually event handlers (see AddEventListener and AddChildEventListener) are not called on disabled, modal or input disabled windows. More...

bool	IsCallHandlersOnInputDisabled () const
	get state of SetCallHandlersOnInputDisabled 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 (long nX, long nY, long nWidth, 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 (vcl::Window *pRelativeWindow) const

bool	IsScrollable () const

virtual void	Scroll (long nHorzScroll, long nVertScroll, ScrollFlags nFlags=ScrollFlags::NONE)

void	Scroll (long nHorzScroll, 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	Flush () override

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	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

long	CalcZoom (long n) 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

vcl::Window *	FindWindow (const Point &rPos) 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, ScrollBar pHScrl, ScrollBar pVScrl)

void	SaveBackground (VirtualDevice &rSaveDevice, const Point &rPos, const Size &rSize, const Size &) const override

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	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...

css::uno::Reference< css::rendering::XCanvas >	GetCanvas () const
	request XCanvas render interface for this window More...

css::uno::Reference< css::rendering::XSpriteCanvas >	GetSpriteCanvas () const
	request XSpriteCanvas render interface for this window 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...

css::uno::Reference< css::datatransfer::clipboard::XClipboard >	GetPrimarySelection ()

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_left (sal_Int32 nWidth)

sal_Int32	get_margin_left () const

void	set_margin_right (sal_Int32 nWidth)

sal_Int32	get_margin_right () 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)

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	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)

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

void	SetAccessibleRelationMemberOf (vcl::Window *pMemberOf)

vcl::Window *	GetAccessibleRelationMemberOf () const

bool	IsAccessibilityEventsSuppressed (bool bTraverseParentPath=true)

void	SetAccessibilityEventsSuppressed (bool bSuppressed)

KeyEvent	GetActivationKey () const

Public Member Functions inherited from OutputDevice
virtual Size	GetButtonBorderSize ()

virtual Color	GetMonochromeButtonColor ()

virtual void	DrawBorder (tools::Rectangle aBorderRect)

SAL_DLLPRIVATE sal_Int32	GetDPIX () const
	Get the output device's DPI x-axis value. More...

SAL_DLLPRIVATE sal_Int32	GetDPIY () const
	Get the output device's DPI y-axis value. More...

SAL_DLLPRIVATE void	SetDPIX (sal_Int32 nDPIX)

SAL_DLLPRIVATE void	SetDPIY (sal_Int32 nDPIY)

float	GetDPIScaleFactor () const

sal_Int32	GetDPIScalePercentage () const

OutDevType	GetOutDevType () const

virtual bool	IsVirtual () const

bool	SupportsOperation (OutDevSupportType) const
	Query an OutputDevice to see whether it supports a specific operation. More...

void	SetExtOutDevData (vcl::ExtOutDevData *pExtOutDevData)

vcl::ExtOutDevData *	GetExtOutDevData () const

void	DrawPixel (const Point &rPt)

void	DrawPixel (const Point &rPt, const Color &rColor)

Color	GetPixel (const Point &rPt) const

void	DrawRect (const tools::Rectangle &rRect)

void	DrawRect (const tools::Rectangle &rRect, sal_uLong nHorzRount, sal_uLong nVertRound)

void	DrawCheckered (const Point &rPos, const Size &rSize, sal_uInt32 nLen=8, Color aStart=COL_WHITE, Color aEnd=COL_BLACK)
	Fill the given rectangle with checkered rectangles of size nLen x nLen using the colors aStart and aEnd. More...

void	DrawGrid (const tools::Rectangle &rRect, const Size &rDist, DrawGridFlags nFlags)

void	Invert (const tools::Rectangle &rRect, InvertFlags nFlags=InvertFlags::NONE)

void	Invert (const tools::Polygon &rPoly, InvertFlags nFlags=InvertFlags::NONE)

void	DrawEllipse (const tools::Rectangle &rRect)

void	DrawArc (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)

void	DrawPie (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)

void	DrawChord (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)

SAL_DLLPRIVATE bool	ImplIsAntiparallel () const

SAL_DLLPRIVATE void	ReMirror (Point &rPoint) const

SAL_DLLPRIVATE void	ReMirror (tools::Rectangle &rRect) const

SAL_DLLPRIVATE void	ReMirror (vcl::Region &rRegion) const

SAL_DLLPRIVATE bool	ImplIsRecordLayout () const

std::unique_ptr< SalLayout >	ImplLayout (const OUString &, sal_Int32 nIndex, sal_Int32 nLen, const Point &rLogicPos=Point(0, 0), long nLogicWidth=0, const long pLogicDXArray=nullptr, SalLayoutFlags flags=SalLayoutFlags::NONE, vcl::TextLayoutCache const =nullptr, const SalLayoutGlyphs *pGlyphs=nullptr) const

SAL_DLLPRIVATE ImplLayoutArgs	ImplPrepareLayoutArgs (OUString &, const sal_Int32 nIndex, const sal_Int32 nLen, DeviceCoordinate nPixelWidth, const DeviceCoordinate pPixelDXArray, SalLayoutFlags flags=SalLayoutFlags::NONE, vcl::TextLayoutCache const =nullptr) const

SAL_DLLPRIVATE std::unique_ptr< SalLayout >	ImplGlyphFallbackLayout (std::unique_ptr< SalLayout >, ImplLayoutArgs &) const

SAL_DLLPRIVATE std::unique_ptr< SalLayout >	getFallbackLayout (LogicalFontInstance *pLogicalFont, int nFallbackLevel, ImplLayoutArgs &rLayoutArgs) const

bool	IsRTLEnabled () const

bool	GetTextIsRTL (const OUString &, sal_Int32 nIndex, sal_Int32 nLen) const

bool	IsNativeControlSupported (ControlType nType, ControlPart nPart) const
	Query the platform layer for control support. More...

bool	HitTestNativeScrollbar (ControlPart nPart, const tools::Rectangle &rControlRegion, const Point &aPos, bool &rIsInside) const
	Query the native control to determine if it was acted upon. More...

bool	DrawNativeControl (ControlType nType, ControlPart nPart, const tools::Rectangle &rControlRegion, ControlState nState, const ImplControlValue &aValue, const OUString &aCaption)
	Request rendering of a particular control and/or part. 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...

bool	DrawEPS (const Point &rPt, const Size &rSz, const GfxLink &rGfxLink, GDIMetaFile *pSubst=nullptr)

SalGraphics const *	GetGraphics () const
	Get the graphic context that the output device uses to draw on. More...

SalGraphics *	GetGraphics ()

void	SetConnectMetaFile (GDIMetaFile *pMtf)

GDIMetaFile *	GetConnectMetaFile () const

const AllSettings &	GetSettings () const

SystemGraphicsData	GetSystemGfxData () const

bool	SupportsCairo () const

cairo::SurfaceSharedPtr	CreateSurface (const cairo::CairoSurfaceSharedPtr &rSurface) const
	Create Surface from given cairo surface. More...

cairo::SurfaceSharedPtr	CreateSurface (int x, int y, int width, int height) const
	Create surface with given dimensions. More...

cairo::SurfaceSharedPtr	CreateBitmapSurface (const BitmapSystemData &rData, const Size &rSize) const
	Create Surface for given bitmap data. More...

css::uno::Any	GetNativeSurfaceHandle (cairo::SurfaceSharedPtr &rSurface, const basegfx::B2ISize &rSize) const
	Return native handle for underlying surface. More...

css::uno::Any	GetSystemGfxDataAny () const

void	SetRefPoint ()

void	SetRefPoint (const Point &rRefPoint)

const Point &	GetRefPoint () const

bool	IsRefPoint () const

virtual bool	IsScreenComp () const

virtual sal_uInt16	GetBitCount () const

Size	GetOutputSizePixel () const

long	GetOutputWidthPixel () const

long	GetOutputHeightPixel () const

long	GetOutOffXPixel () const

long	GetOutOffYPixel () const

void	SetOutOffXPixel (long nOutOffX)

void	SetOutOffYPixel (long nOutOffY)

Size	GetOutputSize () const

css::uno::Reference< css::awt::XGraphics >	CreateUnoGraphics ()

std::vector< VCLXGraphics * > *	GetUnoGraphicsList () const

std::vector< VCLXGraphics * > *	CreateUnoGraphicsList ()

virtual void	DrawOutDev (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPt, const Size &rSrcSize)

virtual void	DrawOutDev (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPt, const Size &rSrcSize, const OutputDevice &rOutDev)

virtual void	CopyArea (const Point &rDestPt, const Point &rSrcPt, const Size &rSrcSize, bool bWindowInvalidate=false)

void	Push (PushFlags nFlags=PushFlags::ALL)

void	Pop ()

sal_uInt32	GetGCStackDepth () const

void	ClearStack ()

void	EnableOutput (bool bEnable=true)

bool	IsOutputEnabled () const

bool	IsDeviceOutputNecessary () const

void	SetAntialiasing (AntialiasingFlags nMode)

AntialiasingFlags	GetAntialiasing () const

void	SetDrawMode (DrawModeFlags nDrawMode)

DrawModeFlags	GetDrawMode () const

void	SetLayoutMode (ComplexTextLayoutFlags nTextLayoutMode)

ComplexTextLayoutFlags	GetLayoutMode () const

void	SetDigitLanguage (LanguageType)

LanguageType	GetDigitLanguage () const

void	SetRasterOp (RasterOp eRasterOp)

RasterOp	GetRasterOp () const

void	SetOutDevViewType (OutDevViewType eOutDevViewType)
	If this OutputDevice is used for displaying a Print Preview the OutDevViewType should be set to 'OutDevViewType::PrintPreview'. More...

OutDevViewType	GetOutDevViewType () const

void	SetLineColor ()

void	SetLineColor (const Color &rColor)

const Color &	GetLineColor () const

bool	IsLineColor () const

void	SetFillColor ()

void	SetFillColor (const Color &rColor)

const Color &	GetFillColor () const

bool	IsFillColor () const

void	SetBackground ()

void	SetBackground (const Wallpaper &rBackground)

const Wallpaper &	GetBackground () const

virtual Color	GetReadableFontColor (const Color &rFontColor, const Color &rBgColor) const

bool	IsBackground () const

void	SetFont (const vcl::Font &rNewFont)

const vcl::Font &	GetFont () const

vcl::Region	GetClipRegion () const

void	SetClipRegion ()

void	SetClipRegion (const vcl::Region &rRegion)

bool	SelectClipRegion (const vcl::Region &, SalGraphics *pGraphics=nullptr)

bool	IsClipRegion () const

void	MoveClipRegion (long nHorzMove, long nVertMove)

void	IntersectClipRegion (const tools::Rectangle &rRect)

void	IntersectClipRegion (const vcl::Region &rRegion)

void	DrawLine (const Point &rStartPt, const Point &rEndPt)

void	DrawLine (const Point &rStartPt, const Point &rEndPt, const LineInfo &rLineInfo)

void	DrawPolyLine (const tools::Polygon &rPoly)
	Render the given polygon as a line stroke. More...

void	DrawPolyLine (const basegfx::B2DPolygon &, double fLineWidth=0.0, basegfx::B2DLineJoin eLineJoin=basegfx::B2DLineJoin::Round, css::drawing::LineCap eLineCap=css::drawing::LineCap_BUTT, double fMiterMinimumAngle=basegfx::deg2rad(15.0))

void	DrawPolyLine (const tools::Polygon &rPoly, const LineInfo &rLineInfo)
	Render the given polygon as a line stroke. More...

bool	DrawPolyLineDirect (const basegfx::B2DHomMatrix &rObjectTransform, const basegfx::B2DPolygon &rB2DPolygon, double fLineWidth=0.0, double fTransparency=0.0, const std::vector< double > *=nullptr, basegfx::B2DLineJoin eLineJoin=basegfx::B2DLineJoin::NONE, css::drawing::LineCap eLineCap=css::drawing::LineCap_BUTT, double fMiterMinimumAngle=basegfx::deg2rad(15.0), bool bBypassAACheck=false)

void	DrawPolygon (const tools::Polygon &rPoly)
	Render the given polygon. More...

void	DrawPolygon (const basegfx::B2DPolygon &)

void	DrawPolyPolygon (const tools::PolyPolygon &rPolyPoly)
	Render the given poly-polygon. More...

void	DrawPolyPolygon (const basegfx::B2DPolyPolygon &)

void	DrawGradient (const tools::Rectangle &rRect, const Gradient &rGradient)

void	DrawGradient (const tools::PolyPolygon &rPolyPoly, const Gradient &rGradient)

void	AddGradientActions (const tools::Rectangle &rRect, const Gradient &rGradient, GDIMetaFile &rMtf)

void	DrawHatch (const tools::PolyPolygon &rPolyPoly, const Hatch &rHatch)

void	AddHatchActions (const tools::PolyPolygon &rPolyPoly, const Hatch &rHatch, GDIMetaFile &rMtf)

void	DrawHatch (const tools::PolyPolygon &rPolyPoly, const Hatch &rHatch, bool bMtf)

void	DrawWallpaper (const tools::Rectangle &rRect, const Wallpaper &rWallpaper)

void	Erase ()

void	Erase (const tools::Rectangle &rRect)

void	DrawText (const Point &rStartPt, const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, MetricVector pVector=nullptr, OUString pDisplayText=nullptr, const SalLayoutGlyphs *pLayoutCache=nullptr)

void	DrawText (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle=DrawTextFlags::NONE, MetricVector pVector=nullptr, OUString pDisplayText=nullptr, vcl::ITextLayout *_pTextLayout=nullptr)

void	ImplDrawText (SalLayout &)

void	ImplDrawTextBackground (const SalLayout &)

void	DrawCtrlText (const Point &rPos, const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, DrawTextFlags nStyle=DrawTextFlags::Mnemonic, MetricVector pVector=nullptr, OUString pDisplayText=nullptr, const SalLayoutGlyphs *pGlyphs=nullptr)

void	DrawTextLine (const Point &rPos, long nWidth, FontStrikeout eStrikeout, FontLineStyle eUnderline, FontLineStyle eOverline, bool bUnderlineAbove=false)

void	ImplDrawTextLine (long nBaseX, long nX, long nY, DeviceCoordinate nWidth, FontStrikeout eStrikeout, FontLineStyle eUnderline, FontLineStyle eOverline, bool bUnderlineAbove)

void	ImplDrawTextLines (SalLayout &, FontStrikeout eStrikeout, FontLineStyle eUnderline, FontLineStyle eOverline, bool bWordLine, bool bUnderlineAbove)

void	DrawWaveLine (const Point &rStartPos, const Point &rEndPos, long nLineWidth=1)

bool	ImplDrawRotateText (SalLayout &)

tools::Rectangle	GetTextRect (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle=DrawTextFlags::WordBreak, TextRectInfo pInfo=nullptr, const vcl::ITextLayout _pTextLayout=nullptr) const

bool	GetTextBoundRect (tools::Rectangle &rRect, const OUString &rStr, sal_Int32 nBase=0, sal_Int32 nIndex=0, sal_Int32 nLen=-1, sal_uLong nLayoutWidth=0, const long pDXArray=nullptr, const SalLayoutGlyphs pGlyphs=nullptr) const
	Return the exact bounding rectangle of rStr. More...

tools::Rectangle	ImplGetTextBoundRect (const SalLayout &)

bool	GetTextOutline (tools::PolyPolygon &, const OUString &rStr, sal_Int32 nLen=-1, sal_uLong nLayoutWidth=0, const long *pDXArray=nullptr) const

bool	GetTextOutlines (PolyPolyVector &, const OUString &rStr, sal_Int32 nBase=0, sal_Int32 nIndex=0, sal_Int32 nLen=-1, sal_uLong nLayoutWidth=0, const long *pDXArray=nullptr) const

bool	GetTextOutlines (basegfx::B2DPolyPolygonVector &rVector, const OUString &rStr, sal_Int32 nBase, sal_Int32 nIndex=0, sal_Int32 nLen=-1, sal_uLong nLayoutWidth=0, const long *pDXArray=nullptr) const

OUString	GetEllipsisString (const OUString &rStr, long nMaxWidth, DrawTextFlags nStyle=DrawTextFlags::EndEllipsis) const

long	GetCtrlTextWidth (const OUString &rStr, const SalLayoutGlyphs *pLayoutCache=nullptr) const

void	AddTextRectActions (const tools::Rectangle &rRect, const OUString &rOrigStr, DrawTextFlags nStyle, GDIMetaFile &rMtf)
	Generate MetaTextActions for the text rect. More...

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

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...

long	GetTextHeight () const
	Height where any character of the current font fits; in logic coordinates. More...

float	approximate_digit_width () const

void	DrawTextArray (const Point &rStartPt, const OUString &rStr, const long pDXAry, sal_Int32 nIndex=0, sal_Int32 nLen=-1, SalLayoutFlags flags=SalLayoutFlags::NONE, const SalLayoutGlyphs pLayoutCache=nullptr)

long	GetTextArray (const OUString &rStr, long pDXAry, sal_Int32 nIndex=0, sal_Int32 nLen=-1, vcl::TextLayoutCache const =nullptr, SalLayoutGlyphs const *const pLayoutCache=nullptr) const

void	GetCaretPositions (const OUString &, long pCaretXArray, sal_Int32 nIndex, sal_Int32 nLen, const SalLayoutGlyphs pGlyphs=nullptr) const

void	DrawStretchText (const Point &rStartPt, sal_uLong nWidth, const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1)

sal_Int32	GetTextBreak (const OUString &rStr, long nTextWidth, sal_Int32 nIndex, sal_Int32 nLen=-1, long nCharExtra=0, vcl::TextLayoutCache const =nullptr, const SalLayoutGlyphs pGlyphs=nullptr) const

sal_Int32	GetTextBreak (const OUString &rStr, long nTextWidth, sal_Unicode nExtraChar, sal_Int32 &rExtraCharPos, sal_Int32 nIndex, sal_Int32 nLen, long nCharExtra, vcl::TextLayoutCache const *=nullptr) const

FontMetric	GetDevFont (int nDevFontIndex) const

int	GetDevFontCount () const

bool	IsFontAvailable (const OUString &rFontName) const

Size	GetDevFontSize (const vcl::Font &rFont, int nSizeIndex) const

int	GetDevFontSizeCount (const vcl::Font &) const

bool	AddTempDevFont (const OUString &rFileURL, const OUString &rFontName)

void	RefreshFontData (const bool bNewFontLists)

FontMetric	GetFontMetric () const

FontMetric	GetFontMetric (const vcl::Font &rFont) const

bool	GetFontCharMap (FontCharMapRef &rxFontCharMap) const

bool	GetFontCapabilities (vcl::FontCapabilities &rFontCapabilities) const

bool	GetFontFeatures (std::vector< vcl::font::Feature > &rFontFeatures) const

SAL_DLLPRIVATE void	ImplGetEmphasisMark (tools::PolyPolygon &rPolyPoly, bool &rPolyLine, tools::Rectangle &rRect1, tools::Rectangle &rRect2, long &rYOff, long &rWidth, FontEmphasisMark eEmphasis, long nHeight)

bool	GetGlyphBoundRects (const Point &rOrigin, const OUString &rStr, int nIndex, int nLen, MetricVector &rVector)

sal_Int32	HasGlyphs (const vcl::Font &rFont, const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1) const

long	GetMinKashida () const

sal_Int32	ValidateKashidas (const OUString &rTxt, sal_Int32 nIdx, sal_Int32 nLen, sal_Int32 nKashCount, const sal_Int32 pKashidaPos, sal_Int32 pKashidaPosDropped) const

SAL_DLLPRIVATE void	ImplInitFontList () const

SAL_DLLPRIVATE void	ImplUpdateFontData ()

void	DrawBitmap (const Point &rDestPt, const Bitmap &rBitmap)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. void DrawBitmap( const Point& rDestPt, const Size& rDestSize, const Point& rSrcPtPixel, const Size& rSecSizePixel, const Bitmap& rBitmap, MetaActionType nAction = MetaActionType::BMPSCALEPART) More...

void	DrawBitmap (const Point &rDestPt, const Size &rDestSize, const Bitmap &rBitmap)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. void DrawBitmap( const Point& rDestPt, const Size& rDestSize, const Point& rSrcPtPixel, const Size& rSecSizePixel, const Bitmap& rBitmap, MetaActionType nAction = MetaActionType::BMPSCALEPART) More...

void	DrawBitmap (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel, const Bitmap &rBitmap, MetaActionType nAction=MetaActionType::BMPSCALEPART)

void	DrawBitmapEx (const Point &rDestPt, const BitmapEx &rBitmapEx)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. void DrawBitmapEx( const Point& rDestPt, const Size& rDestSize, const Point& rSrcPtPixel, const Size& rSecSizePixel, const BitmapEx& rBitmapEx, MetaActionType nAction = MetaActionType::BMPEXSCALEPART) More...

void	DrawBitmapEx (const Point &rDestPt, const Size &rDestSize, const BitmapEx &rBitmapEx)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. void DrawBitmapEx( const Point& rDestPt, const Size& rDestSize, const Point& rSrcPtPixel, const Size& rSecSizePixel, const BitmapEx& rBitmapEx, MetaActionType nAction = MetaActionType::BMPEXSCALEPART) More...

void	DrawBitmapEx (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel, const BitmapEx &rBitmapEx, MetaActionType nAction=MetaActionType::BMPEXSCALEPART)

void	DrawImage (const Point &rPos, const Image &rImage, DrawImageFlags nStyle=DrawImageFlags::NONE)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. virtual void DrawImage( const Point& rPos, const Size& rSize, const Image& rImage, sal_uInt16 nStyle = 0) More...

void	DrawImage (const Point &rPos, const Size &rSize, const Image &rImage, DrawImageFlags nStyle=DrawImageFlags::NONE)

virtual Bitmap	GetBitmap (const Point &rSrcPt, const Size &rSize) const

BitmapEx	GetBitmapEx (const Point &rSrcPt, const Size &rSize) const
	Query extended bitmap (with alpha channel, if available). More...

void	DrawTransformedBitmapEx (const basegfx::B2DHomMatrix &rTransformation, const BitmapEx &rBitmapEx)
	Draw BitmapEx transformed. More...

void	DrawShadowBitmapEx (const BitmapEx &rBitmapEx,::Color aShadowColor)

bool	RemoveTransparenciesFromMetaFile (const GDIMetaFile &rInMtf, GDIMetaFile &rOutMtf, long nMaxBmpDPIX, long nMaxBmpDPIY, bool bReduceTransparency, bool bTransparencyAutoMode, bool bDownsampleBitmaps, const Color &rBackground=COL_TRANSPARENT)
	helper method removing transparencies from a metafile (e.g. More...

SAL_DLLPRIVATE void	ImplPrintTransparent (const Bitmap &rBmp, const Bitmap &rMask, const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel)

SAL_DLLPRIVATE Color	ImplDrawModeToColor (const Color &rColor) const

void	DrawTransparent (const tools::PolyPolygon &rPolyPoly, sal_uInt16 nTransparencePercent)

void	DrawTransparent (const basegfx::B2DHomMatrix &rObjectTransform, const basegfx::B2DPolyPolygon &rB2DPolyPoly, double fTransparency)

void	DrawTransparent (const GDIMetaFile &rMtf, const Point &rPos, const Size &rSize, const Gradient &rTransparenceGradient)

void	DrawMask (const Point &rDestPt, const Bitmap &rBitmap, const Color &rMaskColor)

void	DrawMask (const Point &rDestPt, const Size &rDestSize, const Bitmap &rBitmap, const Color &rMaskColor)

void	DrawMask (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel, const Bitmap &rBitmap, const Color &rMaskColor, MetaActionType nAction)

void	EnableMapMode (bool bEnable=true)

bool	IsMapModeEnabled () const

void	SetMapMode ()

virtual void	SetMapMode (const MapMode &rNewMapMode)

void	SetRelativeMapMode (const MapMode &rNewMapMode)

virtual void	SetMetafileMapMode (const MapMode &rNewMapMode, bool bIsRecord)

const MapMode &	GetMapMode () const

basegfx::B2DHomMatrix	GetViewTransformation () const

basegfx::B2DHomMatrix	GetInverseViewTransformation () const

basegfx::B2DHomMatrix	GetViewTransformation (const MapMode &rMapMode) const

basegfx::B2DHomMatrix	GetInverseViewTransformation (const MapMode &rMapMode) const

void	SetPixelOffset (const Size &rOffset)
	Set an offset in pixel. More...

Size	GetPixelOffset () const
	Get the offset in pixel. More...

Point	LogicToPixel (const Point &rLogicPt) const

Size	LogicToPixel (const Size &rLogicSize) const

tools::Rectangle	LogicToPixel (const tools::Rectangle &rLogicRect) const

tools::Polygon	LogicToPixel (const tools::Polygon &rLogicPoly) const

tools::PolyPolygon	LogicToPixel (const tools::PolyPolygon &rLogicPolyPoly) const

basegfx::B2DPolyPolygon	LogicToPixel (const basegfx::B2DPolyPolygon &rLogicPolyPoly) 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

tools::Polygon	LogicToPixel (const tools::Polygon &rLogicPoly, const MapMode &rMapMode) const

basegfx::B2DPolyPolygon	LogicToPixel (const basegfx::B2DPolyPolygon &rLogicPolyPoly, 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::Polygon	PixelToLogic (const tools::Polygon &rDevicePoly) const

tools::PolyPolygon	PixelToLogic (const tools::PolyPolygon &rDevicePolyPoly) const

basegfx::B2DPolyPolygon	PixelToLogic (const basegfx::B2DPolyPolygon &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

tools::Polygon	PixelToLogic (const tools::Polygon &rDevicePoly, const MapMode &rMapMode) const

basegfx::B2DPolygon	PixelToLogic (const basegfx::B2DPolygon &rDevicePoly, const MapMode &rMapMode) const

basegfx::B2DPolyPolygon	PixelToLogic (const basegfx::B2DPolyPolygon &rDevicePolyPoly, const MapMode &rMapMode) const

Point	LogicToLogic (const Point &rPtSource, const MapMode pMapModeSource, const MapMode pMapModeDest) const

Size	LogicToLogic (const Size &rSzSource, const MapMode pMapModeSource, const MapMode pMapModeDest) const

tools::Rectangle	LogicToLogic (const tools::Rectangle &rRectSource, const MapMode pMapModeSource, const MapMode pMapModeDest) const

SAL_DLLPRIVATE tools::Rectangle	ImplLogicToDevicePixel (const tools::Rectangle &rLogicRect) const
	Convert a logical rectangle to a rectangle in physical device pixel units. More...

SAL_DLLPRIVATE Point	ImplLogicToDevicePixel (const Point &rLogicPt) const
	Convert a logical point to a physical point on the device. More...

SAL_DLLPRIVATE long	ImplLogicWidthToDevicePixel (long nWidth) const
	Convert a logical width to a width in units of device pixels. More...

SAL_DLLPRIVATE DeviceCoordinate	LogicWidthToDeviceCoordinate (long nWidth) const

SAL_DLLPRIVATE long	ImplLogicXToDevicePixel (long nX) const
	Convert a logical X coordinate to a device pixel's X coordinate. More...

SAL_DLLPRIVATE long	ImplLogicYToDevicePixel (long nY) const
	Convert a logical Y coordinate to a device pixel's Y coordinate. More...

SAL_DLLPRIVATE long	ImplLogicHeightToDevicePixel (long nHeight) const
	Convert a logical height to a height in units of device pixels. More...

SAL_DLLPRIVATE long	ImplDevicePixelToLogicWidth (long nWidth) const
	Convert device pixels to a width in logical units. More...

SAL_DLLPRIVATE long	ImplDevicePixelToLogicHeight (long nHeight) const
	Convert device pixels to a height in logical units. More...

SAL_DLLPRIVATE float	ImplFloatLogicHeightToDevicePixel (float fLogicHeight) const
	Convert logical height to device pixels, with exact sub-pixel value. More...

SAL_DLLPRIVATE Size	ImplLogicToDevicePixel (const Size &rLogicSize) const
	Convert a logical size to the size on the physical device. More...

SAL_DLLPRIVATE tools::Rectangle	ImplDevicePixelToLogic (const tools::Rectangle &rPixelRect) const
	Convert a rectangle in physical pixel units to a rectangle in physical pixel units and coords. More...

SAL_DLLPRIVATE tools::Polygon	ImplLogicToDevicePixel (const tools::Polygon &rLogicPoly) const
	Convert a logical polygon to a polygon in physical device pixel units. More...

SAL_DLLPRIVATE tools::PolyPolygon	ImplLogicToDevicePixel (const tools::PolyPolygon &rLogicPolyPoly) const
	Convert a logical polypolygon to a polypolygon in physical device pixel units. More...

SAL_DLLPRIVATE LineInfo	ImplLogicToDevicePixel (const LineInfo &rLineInfo) const
	Convert a line in logical units to a line in physical device pixel units. More...

SAL_DLLPRIVATE vcl::Region	ImplPixelToDevicePixel (const vcl::Region &rRegion) const
	Convert a region in pixel units to a region in device pixel units and coords. More...

SAL_DLLPRIVATE void	ImplInvalidateViewTransform ()
	Invalidate the view transformation. More...

SAL_DLLPRIVATE basegfx::B2DHomMatrix	ImplGetDeviceTransformation () const
	Get device transformation. More...

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 ()

template<typename T >
T *	get (VclPtr< T > &ret, const OString &sID)

template<typename T = vcl::Window>
T *	get (const OString &sID)

void	setDeferredProperties ()

OString	getUIFile () const

Public Attributes
VclPtr< OKButton >	m_pFinish

VclPtr< CancelButton >	m_pCancel

VclPtr< PushButton >	m_pNextPage

VclPtr< PushButton >	m_pPrevPage

VclPtr< HelpButton >	m_pHelp

Protected Member Functions
long	LogicalCoordinateToPixel (int iCoordinate)

void	SetLeftAlignedButtonCount (sal_Int16 _nCount)
	sets the number of buttons which should be left-aligned. More...

void	CalcAndSetSize ()

VclPtr< TabPage >	createPage (WizardTypes::WizardState nState)
	to override to create new pages More...

void	enterState (WizardTypes::WizardState _nState)
	will be called when a new page is about to be displayed More...

bool	prepareLeaveCurrentState (WizardTypes::CommitPageReason eReason)
	will be called when the current state is about to be left for the given reason More...

WizardTypes::WizardState	determineNextState (WizardTypes::WizardState nCurrentState) const
	determine the next state to travel from the given one More...

bool	travelNext ()
	travel to the next state More...

bool	travelPrevious ()
	travel to the previous state More...

bool	isAutomaticNextButtonStateEnabled () const
	enables the automatic enabled/disabled state of the "Next" button More...

void	removePageFromHistory (WizardTypes::WizardState nToRemove)
	removes a page from the history. More...

bool	skipUntil (WizardTypes::WizardState nTargetState)
	skips one or more states, until a given state is reached More...

bool	skipBackwardUntil (WizardTypes::WizardState nTargetState)
	moves back one or more states, until a given state is reached More...

WizardTypes::WizardState	getCurrentState () const
	returns the current state of the machine More...

OUString	getStateDisplayName (WizardTypes::WizardState nState) const
	returns a human readable name for a given state More...

TabPage *	GetOrCreatePage (const WizardTypes::WizardState i_nState)

Protected Member Functions inherited from Dialog
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, const OUString &rID, const OUString &rUIXMLDescription)

virtual void	Draw (OutputDevice *pDev, const Point &rPos, DrawFlags nFlags) override

virtual void	settingOptimalLayoutSize (Window *pBox) override

void	set_action_area (VclButtonBox *pBox)

virtual void	set_content_area (VclBox *pBox)

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)

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, long nHorzScroll, long nVertScroll, bool bChildren)

SAL_DLLPRIVATE void	ImplMoveAllInvalidateRegions (const tools::Rectangle &rRect, long nHorzScroll, 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, long nHorzScroll, 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 bool	AcquireGraphics () const override
	Acquire a graphics device that the output device uses to draw on. More...

virtual void	ReleaseGraphics (bool bRelease=true) override
	Release the graphics device, and remove it from the graphics device list. More...

virtual void	InitClipRegion () override

void	ImplClearFontData (bool bNewFontLists) override

void	ImplRefreshFontData (bool bNewFontLists) override

void	ImplInitMapModeObjects () override

virtual void	ImplAdjustNWFSizes ()

virtual void	CopyDeviceArea (SalTwoRect &aPosAry, bool bWindowInvalidate) override

virtual const OutputDevice *	DrawOutDevDirectCheck (const OutputDevice *pSrcDev) const override

virtual void	DrawOutDevDirectProcess (const OutputDevice pSrcDev, SalTwoRect &rPosAry, SalGraphics pSrcGraphics) override

virtual void	ClipToPaintRegion (tools::Rectangle &rDstRect) override

virtual bool	UsePolyPolygonForComplexGradient () override

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 OutputDevice
	OutputDevice (OutDevType eOutDevType)

virtual	~OutputDevice () override

virtual tools::Rectangle	GetBackgroundComponentBounds () const

SAL_DLLPRIVATE void	drawOutDevDirect (const OutputDevice *pSrcDev, SalTwoRect &rPosAry)

SAL_DLLPRIVATE bool	is_double_buffered_window () const

virtual void	ImplReleaseFonts ()

virtual vcl::Region	ClipToDeviceBounds (vcl::Region aRegion) const
	Perform actual rect clip against outdev dimensions, to generate empty clips whenever one of the values is completely off the device. More...

virtual void	DrawHatchLine_DrawLine (const Point &rStartPoint, const Point &rEndPoint)

virtual long	GetGradientStepCount (long nMinRect)

void	DrawGradientWallpaper (long nX, long nY, long nWidth, long nHeight, const Wallpaper &rWallpaper)

SAL_DLLPRIVATE void	ImplInitTextLineSize ()

SAL_DLLPRIVATE void	ImplInitAboveTextLineSize ()

SAL_DLLPRIVATE float	approximate_char_width () const

SAL_DLLPRIVATE const LogicalFontInstance *	GetFontInstance () const

SAL_DLLPRIVATE long	GetEmphasisAscent () const

SAL_DLLPRIVATE long	GetEmphasisDescent () const

SAL_DLLPRIVATE bool	InitFont () const

virtual void	SetFontOrientation (LogicalFontInstance *const pFontInstance) const

virtual long	GetFontExtLeading () const

void	ReleaseFontCache ()

void	ReleaseFontCollection ()

void	SetFontCollectionFromSVData ()

void	ResetNewFontCache ()

virtual void	DrawDeviceBitmap (const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel, BitmapEx &rBitmapEx)

virtual void	ScaleBitmap (Bitmap &rBmp, SalTwoRect &rPosAry)

virtual bool	DrawTransformBitmapExDirect (const basegfx::B2DHomMatrix &aFullTransform, const BitmapEx &rBitmapEx)
	Transform and draw a bitmap directly. More...

virtual bool	TransformAndReduceBitmapExToTargetRange (const basegfx::B2DHomMatrix &aFullTransform, basegfx::B2DRange &aVisibleRange, double &fMaximumArea)
	Transform and reduce the area that needs to be drawn of the bitmap and return the new visible range and the maximum area. More...

virtual void	EmulateDrawTransparent (const tools::PolyPolygon &rPolyPoly, sal_uInt16 nTransparencePercent)

void	DrawInvisiblePolygon (const tools::PolyPolygon &rPolyPoly)

virtual void	ClipAndDrawGradientMetafile (const Gradient &rGradient, const tools::PolyPolygon &rPolyPoly)

virtual void	DrawDeviceMask (const Bitmap &rMask, const Color &rMaskColor, const Point &rDestPt, const Size &rDestSize, const Point &rSrcPtPixel, const Size &rSrcSizePixel)

Protected Member Functions inherited from VclReferenceBase
	VclReferenceBase ()

virtual	~VclReferenceBase ()

Static Protected Member Functions
static IWizardPageController *	getPageController (TabPage *_pCurrentPage)

Static Protected Member Functions inherited from OutputDevice
static SAL_DLLPRIVATE long	ImplGetTextLines (ImplMultiTextLineInfo &rLineInfo, long nWidth, const OUString &rStr, DrawTextFlags nStyle, const vcl::ITextLayout &_rLayout)

Private Member Functions
	DECL_LINK (ImplHandleWizardLayoutTimerHdl, Timer *, void)

	DECL_LINK (OnRoadmapItemSelected, LinkParamNone *, void)

void	implUpdateRoadmap ()
	updates the roadmap control to show the given path, as far as possible (modulo conflicts with other paths) More...

void	ImplCalcSize (Size &rSize)

void	ImplPosCtrls ()

void	ImplPosTabPage ()

void	ImplShowTabPage (TabPage *pPage)

TabPage *	ImplGetPage (sal_uInt16 nLevel) const

	DECL_LINK (OnNextPage, Button *, void)

	DECL_LINK (OnPrevPage, Button *, void)

	DECL_LINK (OnFinish, Button *, void)

void	implUpdateTitle ()

void	implConstruct (const WizardButtonFlags _nButtonFlags)

Private Attributes
Idle	maWizardLayoutIdle

Size	maPageSize

ImplWizPageData *	mpFirstPage

ImplWizButtonData *	mpFirstBtn

VclPtr< TabPage >	mpCurTabPage

VclPtr< PushButton >	mpPrevBtn

VclPtr< PushButton >	mpNextBtn

VclPtr< vcl::Window >	mpViewWindow

sal_uInt16	mnCurLevel

sal_Int16	mnLeftAlignCount

bool	mbEmptyViewMargin

std::unique_ptr< WizardMachineImplData >	m_xWizardImpl

std::unique_ptr< RoadmapWizardImpl >	m_xRoadmapImpl

Additional Inherited Members
Public Types inherited from Dialog
enum	InitFlag { InitFlag::Default, InitFlag::NoParent }

Static Public Member Functions inherited from Dialog
static vcl::Window *	GetDefaultParent (WinBits nStyle)

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...

Static Public Member Functions inherited from OutputDevice
static void	ImplDrawText (OutputDevice &rTargetDevice, const tools::Rectangle &rRect, const OUString &rOrigStr, DrawTextFlags nStyle, MetricVector pVector, OUString pDisplayText, vcl::ITextLayout &_rLayout)

static OUString	GetNonMnemonicString (const OUString &rStr, sal_Int32 &rMnemonicPos)

static OUString	GetNonMnemonicString (const OUString &rStr)

static std::shared_ptr< vcl::TextLayoutCache >	CreateTextLayoutCache (OUString const &)

static SAL_DLLPRIVATE FontEmphasisMark	ImplGetEmphasisMarkStyle (const vcl::Font &rFont)

static void	BeginFontSubstitution ()

static void	EndFontSubstitution ()

static void	AddFontSubstitute (const OUString &rFontName, const OUString &rReplaceFontName, AddFontSubstituteFlags nFlags)

static void	RemoveFontsSubstitute ()

static vcl::Font	GetDefaultFont (DefaultFontType nType, LanguageType eLang, GetDefaultFontFlags nFlags, const OutputDevice *pOutDev=nullptr)

static SAL_DLLPRIVATE void	ImplClearAllFontData (bool bNewFontLists)

static SAL_DLLPRIVATE void	ImplRefreshAllFontData (bool bNewFontLists)

static SAL_DLLPRIVATE void	ImplUpdateAllFontData (bool bNewFontLists)

static void	LockFontUpdates (bool bLock)

static Point	LogicToLogic (const Point &rPtSource, const MapMode &rMapModeSource, const MapMode &rMapModeDest)

static Size	LogicToLogic (const Size &rSzSource, const MapMode &rMapModeSource, const MapMode &rMapModeDest)

static tools::Rectangle	LogicToLogic (const tools::Rectangle &rRectSource, const MapMode &rMapModeSource, const MapMode &rMapModeDest)

static long	LogicToLogic (long nLongSource, MapUnit eUnitSource, MapUnit eUnitDest)

static basegfx::B2DPolygon	LogicToLogic (const basegfx::B2DPolygon &rPoly, const MapMode &rMapModeSource, const MapMode &rMapModeDest)

static basegfx::B2DHomMatrix	LogicToLogic (const MapMode &rMapModeSource, const MapMode &rMapModeDest)

Static Public Member Functions inherited from VclBuilderContainer
static OUString	getUIRootDir ()

Protected Attributes inherited from SystemWindow
bool	mbIsDeferredInit

VclPtr< vcl::Window >	mpDialogParent

Protected Attributes inherited from VclBuilderContainer
std::unique_ptr< VclBuilder >	m_pUIBuilder

Detailed Description

wizard for a roadmap

The basic new concept introduced is a path:
A path is a sequence of states, which are to be executed in a linear order. Elements in the path can be skipped, depending on choices the user makes.

In the most simple wizards, you will have only one path consisting of n elements, which are to be visited successively.

In a slightly more complex wizard, you will have one linear path, were certain steps might be skipped due to user input. For instance, the user may decide to not specify certain aspects of the to-be-created object (e.g. by unchecking a check box), and the wizard then will simply disable the step which corresponds to this step.

In a yet more advanced wizards, you will have several paths of length n1 and n2, which share at least the first k states (where k is at least 1), and an arbitrary number of other states.

Definition at line 65 of file wizdlg.hxx.

Constructor & Destructor Documentation

vcl::RoadmapWizard::RoadmapWizard	(	vcl::Window *	pParent,
		WinBits	nStyle = `WB_STDDIALOG`,
		InitFlag	eFlag = `InitFlag::Default`
	)

Definition at line 124 of file roadmapwizard.cxx.

References CANCEL, FINISH, vcl::Window::GetSizePixel(), Height, HELP, implConstruct(), LINK, OutputDevice::LogicToPixel(), m_xRoadmapImpl, maWizardLayoutIdle, mbEmptyViewMargin, mnCurLevel, mnLeftAlignCount, mpCurTabPage, mpFirstBtn, mpFirstPage, mpNextBtn, mpPrevBtn, mpViewWindow, NEXT, Point, PREVIOUS, RESIZE, Size::setHeight(), Timer::SetInvokeHandler(), SetLeftAlignedButtonCount(), Task::SetPriority(), VclResId(), and WB_TABSTOP.

vcl::RoadmapWizard::~RoadmapWizard ( )

overridevirtual

Definition at line 178 of file roadmapwizard.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

void vcl::RoadmapWizard::ActivatePage ( )

Definition at line 514 of file wizardmachine.cxx.

References enterState(), GetCurLevel(), and GetOrCreatePage().

Referenced by ShowPage().

void vcl::RoadmapWizard::AddButton	(	Button *	pButton,
		long	nOffset = `0`
	)

Definition at line 617 of file wizardmachine.cxx.

References ImplWizButtonData::mnOffset, ImplWizButtonData::mpButton, mpFirstBtn, and ImplWizButtonData::mpNext.

Referenced by implConstruct().

void vcl::RoadmapWizard::AddPage ( TabPage * pPage )

Definition at line 539 of file wizardmachine.cxx.

References mpFirstPage, ImplWizPageData::mpNext, and ImplWizPageData::mpPage.

Referenced by GetOrCreatePage().

void vcl::RoadmapWizard::CalcAndSetSize ( )

protected

Definition at line 401 of file wizardmachine.cxx.

References GetPageSizePixel(), vcl::Window::GetSizePixel(), Size::Height(), ImplCalcSize(), mpFirstPage, ImplWizPageData::mpNext, ImplWizPageData::mpPage, Size::setHeight(), SystemWindow::SetMinOutputSizePixel(), vcl::Window::SetOutputSizePixel(), Size::setWidth(), and Size::Width().

Referenced by ShowRoadmap(), and StateChanged().

bool vcl::RoadmapWizard::canAdvance ( ) const

determines whether there is a next state to which we can advance

Definition at line 553 of file roadmapwizard.cxx.

References getCurrentState(), vcl::RoadmapWizardImpl::getFirstDifferentIndex(), vcl::RoadmapWizardImpl::getStateIndexInPath(), and m_xRoadmapImpl.

Referenced by enterState().

VclPtr< TabPage > vcl::RoadmapWizard::createPage ( WizardTypes::WizardState nState )

protected

to override to create new pages

Definition at line 776 of file roadmapwizard.cxx.

References m_xRoadmapImpl, and pos.

Referenced by GetOrCreatePage().

vcl::RoadmapWizard::DECL_LINK	(	ImplHandleWizardLayoutTimerHdl	,
		Timer *	,
		void
	)

private

vcl::RoadmapWizard::DECL_LINK	(	OnRoadmapItemSelected	,
		LinkParamNone *	,
		void
	)

private

vcl::RoadmapWizard::DECL_LINK	(	OnNextPage	,
		Button *	,
		void
	)

private

vcl::RoadmapWizard::DECL_LINK	(	OnPrevPage	,
		Button *	,
		void
	)

private

vcl::RoadmapWizard::DECL_LINK	(	OnFinish	,
		Button *	,
		void
	)

private

void vcl::RoadmapWizard::DeleteRoadmapItems ( )

Definition at line 835 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

WizardTypes::WizardState vcl::RoadmapWizard::determineNextState ( WizardTypes::WizardState nCurrentState ) const

protected

determine the next state to travel from the given one

This method ensures that traveling happens along the active path.

Return WZS_INVALID_STATE to prevent traveling.

See also: activatePath

Definition at line 497 of file roadmapwizard.cxx.

References DBG_ASSERT, vcl::RoadmapWizardImpl::getStateIndexInPath(), m_xRoadmapImpl, and WZS_INVALID_STATE.

Referenced by skipUntil(), and travelNext().

void vcl::RoadmapWizard::dispose ( void )

overridevirtual

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

Reimplemented from Dialog.

Definition at line 187 of file roadmapwizard.cxx.

References VclPtr< reference_type >::clear(), Dialog::dispose(), VclPtr< reference_type >::disposeAndClear(), VclReferenceBase::disposeOnce(), GetPage(), i, m_pCancel, m_pFinish, m_pHelp, m_pNextPage, m_pPrevPage, m_xRoadmapImpl, m_xWizardImpl, maWizardLayoutIdle, ImplWizButtonData::mpButton, mpCurTabPage, mpFirstBtn, mpFirstPage, mpNextBtn, ImplWizPageData::mpPage, mpPrevBtn, mpViewWindow, RemoveButton(), RemovePage(), and Task::Stop().

void vcl::RoadmapWizard::enableButtons	(	WizardButtonFlags	_nWizardButtonFlags,
		bool	_bEnable
	)

enable (or disable) buttons

Definition at line 658 of file wizardmachine.cxx.

References CANCEL, vcl::Window::Enable(), FINISH, HELP, m_pCancel, m_pFinish, m_pHelp, m_pNextPage, m_pPrevPage, NEXT, and PREVIOUS.

Referenced by enterState().

void vcl::RoadmapWizard::enterState ( WizardTypes::WizardState _nState )

protected

will be called when a new page is about to be displayed

Definition at line 720 of file roadmapwizard.cxx.

References canAdvance(), enableButtons(), getCurrentState(), GetPage(), getPageController(), implUpdateRoadmap(), implUpdateTitle(), vcl::IWizardPageController::initializePage(), isAutomaticNextButtonStateEnabled(), m_xRoadmapImpl, m_xWizardImpl, NEXT, and PREVIOUS.

Referenced by ActivatePage().

bool vcl::RoadmapWizard::EventNotify ( NotifyEvent & rNEvt )

overridevirtual

Reimplemented from Dialog.

Definition at line 443 of file wizardmachine.cxx.

References Button::Click(), Dialog::EventNotify(), vcl::KeyCode::GetCode(), KeyEvent::GetKeyCode(), NotifyEvent::GetKeyEvent(), NotifyEvent::GetType(), vcl::Window::IsEnabled(), vcl::Window::IsInputEnabled(), vcl::KeyCode::IsMod1(), vcl::KeyCode::IsShift(), vcl::Window::IsVisible(), KEY_PAGEDOWN, KEY_PAGEUP, KEY_TAB, KEYINPUT, mpNextBtn, mpPrevBtn, and PushButton::SetPressed().

bool vcl::RoadmapWizard::Finish ( long nResult = 0 )

Definition at line 530 of file wizardmachine.cxx.

References Dialog::Close(), Dialog::EndDialog(), vcl::Window::GetStyle(), Dialog::IsInExecute(), and WB_CLOSEABLE.

sal_uInt16 vcl::RoadmapWizard::GetCurLevel ( ) const

inline

Definition at line 124 of file wizdlg.hxx.

References mnCurLevel.

Referenced by ActivatePage(), getCurrentState(), and IMPL_LINK_NOARG().

int vcl::RoadmapWizard::GetCurrentRoadmapItemID ( ) const

Definition at line 846 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by RoadmapWizardUIObject::get_state(), and IMPL_LINK_NOARG().

WizardTypes::WizardState vcl::RoadmapWizard::getCurrentState ( ) const

inlineprotected

returns the current state of the machine

Vulgo, this is the identifier of the current tab page :)

Definition at line 239 of file wizdlg.hxx.

References GetCurLevel().

Referenced by canAdvance(), enterState(), implUpdateRoadmap(), implUpdateTitle(), prepareLeaveCurrentState(), skipBackwardUntil(), skipUntil(), and travelNext().

TabPage * vcl::RoadmapWizard::GetOrCreatePage ( const WizardTypes::WizardState i_nState )

protected

Definition at line 487 of file wizardmachine.cxx.

References AddPage(), createPage(), DBG_ASSERT, GetPage(), m_xWizardImpl, and SetPage().

Referenced by ActivatePage().

TabPage * vcl::RoadmapWizard::GetPage ( sal_uInt16 nLevel ) const

Definition at line 602 of file wizardmachine.cxx.

References mpFirstPage, and ImplWizPageData::mpNext.

Referenced by dispose(), enterState(), GetOrCreatePage(), implUpdateRoadmap(), implUpdateTitle(), and prepareLeaveCurrentState().

IWizardPageController * vcl::RoadmapWizard::getPageController ( TabPage * _pCurrentPage )

staticprotected

Definition at line 845 of file wizardmachine.cxx.

Referenced by enterState(), implUpdateRoadmap(), and prepareLeaveCurrentState().

const Size& vcl::RoadmapWizard::GetPageSizePixel ( ) const

inline

Definition at line 135 of file wizdlg.hxx.

References maPageSize.

Referenced by CalcAndSetSize().

OUString vcl::RoadmapWizard::getStateDisplayName ( WizardTypes::WizardState nState ) const

protected

returns a human readable name for a given state

There is a default implementation for this method, which returns the display name as given in a call to describeState. If there is no description for the given state, this is worth an assertion in a non-product build, and then an empty string is returned.

Definition at line 750 of file roadmapwizard.cxx.

References m_xRoadmapImpl, pos, and sDisplayName.

Referenced by implUpdateRoadmap().

FactoryFunction vcl::RoadmapWizard::GetUITestFactory ( ) const

overridevirtual

Reimplemented from Dialog.

Definition at line 851 of file roadmapwizard.cxx.

References RoadmapWizardUIObject::create().

void vcl::RoadmapWizard::ImplCalcSize ( Size & rSize )

private

Definition at line 83 of file wizardmachine.cxx.

References Size::AdjustHeight(), Size::AdjustWidth(), vcl::Window::GetSizePixel(), Size::Height(), vcl::Window::IsVisible(), LogicalCoordinateToPixel(), ImplWizButtonData::mnOffset, ImplWizButtonData::mpButton, mpFirstBtn, ImplWizButtonData::mpNext, mpViewWindow, Size::setWidth(), Size::Width(), WIZARDDIALOG_BUTTON_DLGOFFSET_X, and WIZARDDIALOG_BUTTON_OFFSET_Y.

Referenced by CalcAndSetSize().

void vcl::RoadmapWizard::implConstruct ( const WizardButtonFlags _nButtonFlags )

private

TabPage * vcl::RoadmapWizard::ImplGetPage ( sal_uInt16 nLevel ) const

private

Definition at line 287 of file wizardmachine.cxx.

References mpFirstPage, ImplWizPageData::mpNext, and ImplWizPageData::mpPage.

Referenced by ShowPage(), and StateChanged().

void vcl::RoadmapWizard::ImplPosCtrls ( )

private

void vcl::RoadmapWizard::ImplPosTabPage ( )

private

void vcl::RoadmapWizard::ImplShowTabPage ( TabPage * pPage )

private

Definition at line 269 of file wizardmachine.cxx.

References vcl::Window::Hide(), ImplPosTabPage(), mpCurTabPage, and vcl::Window::Show().

Referenced by ShowPage(), and StateChanged().

void vcl::RoadmapWizard::implUpdateRoadmap ( )

private

updates the roadmap control to show the given path, as far as possible (modulo conflicts with other paths)

Definition at line 288 of file roadmapwizard.cxx.

References vcl::IWizardPageController::canAdvance(), DBG_ASSERT, getCurrentState(), vcl::RoadmapWizardImpl::getFirstDifferentIndex(), GetPage(), getPageController(), getStateDisplayName(), vcl::RoadmapWizardImpl::getStateIndexInPath(), m_xRoadmapImpl, and nState.

Referenced by enterState().

void vcl::RoadmapWizard::implUpdateTitle ( )

private

Definition at line 387 of file wizardmachine.cxx.

References getCurrentState(), GetPage(), vcl::Window::GetText(), m_xWizardImpl, and SystemWindow::SetText().

Referenced by enterState().

void vcl::RoadmapWizard::InsertRoadmapItem	(	int	nIndex,
		const OUString &	rLabel,
		int	nId,
		bool	bEnabled
	)

Definition at line 825 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

bool vcl::RoadmapWizard::isAutomaticNextButtonStateEnabled ( ) const

protected

enables the automatic enabled/disabled state of the "Next" button

If this is <TRUE>, then upon entering a new state, the "Next" button will automatically be enabled if and only if determineNextState does not return WZS_INVALID_STATE.

Definition at line 824 of file wizardmachine.cxx.

References m_xWizardImpl.

Referenced by enterState().

bool vcl::RoadmapWizard::isTravelingSuspended ( ) const

Definition at line 851 of file wizardmachine.cxx.

References m_xWizardImpl.

long vcl::RoadmapWizard::LogicalCoordinateToPixel ( int iCoordinate )

protected

Definition at line 220 of file wizardmachine.cxx.

References OutputDevice::LogicToPixel(), and Size::Width().

Referenced by ImplCalcSize(), and ImplPosCtrls().

bool vcl::RoadmapWizard::prepareLeaveCurrentState ( WizardTypes::CommitPageReason eReason )

protected

will be called when the current state is about to be left for the given reason

The base implementation in this class will simply call <member>OWizardPage::commitPage</member> for the current page, and return whatever this call returns.

Parameters

_eReason The reason why the state is to be left.

Returns: <TRUE> if and only if the page is allowed to be left

Definition at line 684 of file wizardmachine.cxx.

References vcl::IWizardPageController::commitPage(), ENSURE_OR_RETURN, getCurrentState(), GetPage(), and getPageController().

Referenced by skipBackwardUntil(), skipUntil(), travelNext(), and travelPrevious().

void vcl::RoadmapWizard::queue_resize ( StateChangedType eReason = StateChangedType::Layout )

overridevirtual

Reimplemented from Dialog.

Definition at line 118 of file wizardmachine.cxx.

References Task::IsActive(), Dialog::IsInClose(), maWizardLayoutIdle, and Idle::Start().

void vcl::RoadmapWizard::RemoveButton ( Button * pButton )

Definition at line 635 of file wizardmachine.cxx.

References ImplWizButtonData::mpButton, mpFirstBtn, and ImplWizButtonData::mpNext.

Referenced by dispose().

void vcl::RoadmapWizard::RemovePage ( TabPage * pPage )

Definition at line 556 of file wizardmachine.cxx.

References mpCurTabPage, mpFirstPage, ImplWizPageData::mpNext, and ImplWizPageData::mpPage.

Referenced by dispose().

void vcl::RoadmapWizard::removePageFromHistory ( WizardTypes::WizardState nToRemove )

protected

removes a page from the history.

Should be called when the page is being disabled

Definition at line 804 of file wizardmachine.cxx.

References m_xWizardImpl.

void vcl::RoadmapWizard::Resize ( )

overridevirtual

Reimplemented from Dialog.

Definition at line 376 of file wizardmachine.cxx.

References ImplPosCtrls(), ImplPosTabPage(), vcl::Window::IsInInitShow(), vcl::Window::IsReallyShown(), and Dialog::Resize().

void vcl::RoadmapWizard::resumeTraveling ( AccessGuard )

Definition at line 862 of file wizardmachine.cxx.

References DBG_ASSERT, and m_xWizardImpl.

void vcl::RoadmapWizard::SelectRoadmapItemByID ( int nId )

Definition at line 830 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by RoadmapWizardUIObject::execute(), and IMPL_LINK_NOARG().

void vcl::RoadmapWizard::SetItemSelectHdl ( const Link< LinkParamNone *, void > & _rHdl )

Definition at line 841 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

void vcl::RoadmapWizard::SetLeftAlignedButtonCount ( sal_Int16 _nCount )

protected

sets the number of buttons which should be left-aligned.

Normally, buttons are right-aligned.

only to be used during construction, before any layouting happened

Definition at line 78 of file wizardmachine.cxx.

References mnLeftAlignCount.

Referenced by RoadmapWizard().

void vcl::RoadmapWizard::SetPage	(	sal_uInt16	nLevel,
		TabPage *	pPage
	)

Definition at line 581 of file wizardmachine.cxx.

References mpCurTabPage, mpFirstPage, ImplWizPageData::mpNext, and ImplWizPageData::mpPage.

Referenced by GetOrCreatePage().

void vcl::RoadmapWizard::SetPageSizePixel ( const Size & rSize )

inline

Definition at line 134 of file wizdlg.hxx.

void vcl::RoadmapWizard::SetRoadmapHelpId ( const OString & _rId )

Definition at line 225 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

bool vcl::RoadmapWizard::ShowPage ( sal_uInt16 nLevel )

Definition at line 522 of file wizardmachine.cxx.

References ActivatePage(), ImplGetPage(), ImplShowTabPage(), and mnCurLevel.

Referenced by skipBackwardUntil(), skipUntil(), travelNext(), and travelPrevious().

void vcl::RoadmapWizard::ShowRoadmap ( bool bShow )

Definition at line 172 of file roadmapwizard.cxx.

References CalcAndSetSize(), and m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

bool vcl::RoadmapWizard::skipBackwardUntil ( WizardTypes::WizardState nTargetState )

protected

moves back one or more states, until a given state is reached

This method allows traveling backwards more than one state without actually showing the intermediate states.

For instance, if you want to travel two steps backward at a time, you could used two travelPrevious calls, but this would show both pages, which is not necessary, since you're interested in the target page only. Using <member>skipBackwardUntil</member> relieves you of this.

Returns: <TRUE> if and only if traveling was successful

See also: skipUntil; skip

Definition at line 691 of file wizardmachine.cxx.

References DBG_ASSERT, vcl::WizardTypes::eTravelBackward, getCurrentState(), m_xWizardImpl, prepareLeaveCurrentState(), and ShowPage().

bool vcl::RoadmapWizard::skipUntil ( WizardTypes::WizardState nTargetState )

protected

skips one or more states, until a given state is reached

The method behaves as if from the current state, <method>travelNext</method>s were called successively, until <arg>_nTargetState</arg> is reached, but without actually creating or displaying the pages.

The skipped states appear in the state history, so <method>travelPrevious</method> will make use of them.