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)

void	Finish (tools::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, tools::Long nOffset=0)

void	RemoveButton (Button *pButton)

void	SetPageSizePixel (const Size &rSize)

const Size &	GetPageSizePixel () const

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, bool bGrabFocus=true)

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	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, ScrollBar pHScrl, ScrollBar 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 ()

Public Attributes
VclPtr< OKButton >	m_pFinish

VclPtr< CancelButton >	m_pCancel

VclPtr< PushButton >	m_pNextPage

VclPtr< PushButton >	m_pPrevPage

VclPtr< HelpButton >	m_pHelp

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

tools::Long	LogicalCoordinateToPixel (int iCoordinate) const

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

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

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

void	travelPrevious ()
	travel to the previous state 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...

	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	GetOrCreatePage (const WizardTypes::WizardState i_nState)

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	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 class	InitFlag { Default , NoParent }

Static Public Member Functions inherited from Dialog
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...

static OUString	GetNonMnemonicString (const OUString &rStr)

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

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

◆ RoadmapWizard()

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, vcl::Window::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.

◆ ~RoadmapWizard()

vcl::RoadmapWizard::~RoadmapWizard ( )

overridevirtual

Definition at line 179 of file roadmapwizard.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

◆ ActivatePage()

void vcl::RoadmapWizard::ActivatePage ( )

Definition at line 500 of file wizardmachine.cxx.

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

Referenced by ShowPage().

◆ AddButton()

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

Definition at line 602 of file wizardmachine.cxx.

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

Referenced by implConstruct().

◆ AddPage()

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

Definition at line 524 of file wizardmachine.cxx.

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

Referenced by GetOrCreatePage().

◆ CalcAndSetSize()

void vcl::RoadmapWizard::CalcAndSetSize ( )

private

Definition at line 388 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().

◆ createPage()

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

private

to override to create new pages

Definition at line 716 of file roadmapwizard.cxx.

References m_xRoadmapImpl, and pos.

Referenced by GetOrCreatePage().

◆ DECL_LINK() [1/5]

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

private

◆ DECL_LINK() [2/5]

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

private

◆ DECL_LINK() [3/5]

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

private

◆ DECL_LINK() [4/5]

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

private

◆ DECL_LINK() [5/5]

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

private

◆ DeleteRoadmapItems()

void vcl::RoadmapWizard::DeleteRoadmapItems ( )

Definition at line 775 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

◆ determineNextState()

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

private

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 482 of file roadmapwizard.cxx.

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

Referenced by skipUntil(), and travelNext().

◆ dispose()

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

◆ enterState()

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

private

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

Definition at line 675 of file roadmapwizard.cxx.

References getCurrentState(), implUpdateRoadmap(), and m_xRoadmapImpl.

Referenced by ActivatePage().

◆ EventNotify()

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

overridevirtual

Reimplemented from Dialog.

Definition at line 430 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().

◆ Finish()

void vcl::RoadmapWizard::Finish ( tools::Long nResult = 0 )

Definition at line 516 of file wizardmachine.cxx.

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

◆ GetCurLevel()

sal_uInt16 vcl::RoadmapWizard::GetCurLevel ( ) const

inline

Definition at line 123 of file wizdlg.hxx.

References mnCurLevel.

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

◆ GetCurrentRoadmapItemID()

int vcl::RoadmapWizard::GetCurrentRoadmapItemID ( ) const

Definition at line 786 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

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

◆ getCurrentState()

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

inlineprivate

returns the current state of the machine

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

Definition at line 213 of file wizdlg.hxx.

References GetCurLevel().

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

◆ GetOrCreatePage()

void vcl::RoadmapWizard::GetOrCreatePage ( const WizardTypes::WizardState i_nState )

private

Definition at line 474 of file wizardmachine.cxx.

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

Referenced by ActivatePage().

◆ GetPage()

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

Definition at line 587 of file wizardmachine.cxx.

References mpFirstPage, and ImplWizPageData::mpNext.

Referenced by dispose(), and GetOrCreatePage().

◆ GetPageSizePixel()

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

inline

Definition at line 134 of file wizdlg.hxx.

References maPageSize.

Referenced by CalcAndSetSize().

◆ getStateDisplayName()

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

private

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 690 of file roadmapwizard.cxx.

References m_xRoadmapImpl, pos, and sDisplayName.

Referenced by implUpdateRoadmap().

◆ GetUITestFactory()

FactoryFunction vcl::RoadmapWizard::GetUITestFactory ( ) const

overridevirtual

Reimplemented from Dialog.

Definition at line 791 of file roadmapwizard.cxx.

References RoadmapWizardUIObject::create().

◆ ImplCalcSize()

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

◆ implConstruct()

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

private

◆ ImplGetPage()

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

private

Definition at line 288 of file wizardmachine.cxx.

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

Referenced by ShowPage(), and StateChanged().

◆ ImplPosCtrls()

void vcl::RoadmapWizard::ImplPosCtrls ( )

private

◆ ImplPosTabPage()

void vcl::RoadmapWizard::ImplPosTabPage ( )

private

◆ ImplShowTabPage()

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

private

Definition at line 270 of file wizardmachine.cxx.

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

Referenced by ShowPage(), and StateChanged().

◆ implUpdateRoadmap()

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 289 of file roadmapwizard.cxx.

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

Referenced by enterState().

◆ InsertRoadmapItem()

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

Definition at line 765 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

◆ isTravelingSuspended()

bool vcl::RoadmapWizard::isTravelingSuspended ( ) const

Definition at line 779 of file wizardmachine.cxx.

References m_xWizardImpl.

◆ LogicalCoordinateToPixel()

tools::Long vcl::RoadmapWizard::LogicalCoordinateToPixel ( int iCoordinate ) const

private

Definition at line 220 of file wizardmachine.cxx.

References vcl::Window::LogicToPixel(), and Size::Width().

Referenced by ImplCalcSize(), and ImplPosCtrls().

◆ queue_resize()

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

◆ RemoveButton()

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

Definition at line 620 of file wizardmachine.cxx.

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

Referenced by dispose().

◆ RemovePage()

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

Definition at line 541 of file wizardmachine.cxx.

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

Referenced by dispose().

◆ removePageFromHistory()

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

private

removes a page from the history.

Should be called when the page is being disabled

Definition at line 743 of file wizardmachine.cxx.

References m_xWizardImpl.

◆ Resize()

void vcl::RoadmapWizard::Resize ( )

overridevirtual

Reimplemented from Dialog.

Definition at line 377 of file wizardmachine.cxx.

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

◆ resumeTraveling()

void vcl::RoadmapWizard::resumeTraveling ( AccessGuard )

Definition at line 790 of file wizardmachine.cxx.

References DBG_ASSERT, and m_xWizardImpl.

◆ SelectRoadmapItemByID()

void vcl::RoadmapWizard::SelectRoadmapItemByID	(	int	nId,
		bool	bGrabFocus = `true`
	)

Definition at line 770 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

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

◆ SetItemSelectHdl()

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

Definition at line 781 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

◆ SetLeftAlignedButtonCount()

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

private

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

◆ SetPage()

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

Definition at line 566 of file wizardmachine.cxx.

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

Referenced by GetOrCreatePage().

◆ SetPageSizePixel()

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

inline

Definition at line 133 of file wizdlg.hxx.

References maPageSize.

◆ SetRoadmapHelpId()

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

Definition at line 226 of file roadmapwizard.cxx.

References m_xRoadmapImpl.

◆ ShowPage()

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

Definition at line 508 of file wizardmachine.cxx.

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

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

◆ ShowRoadmap()

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

Definition at line 173 of file roadmapwizard.cxx.

References CalcAndSetSize(), and m_xRoadmapImpl.

Referenced by IMPL_LINK_NOARG().

◆ skipBackwardUntil()

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

private

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 651 of file wizardmachine.cxx.

References DBG_ASSERT, getCurrentState(), m_xWizardImpl, and ShowPage().

◆ skipUntil()

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

private

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 \EDntermediate pages.

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

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

See also: skip; skipBackwardUntil

Definition at line 673 of file wizardmachine.cxx.

References determineNextState(), getCurrentState(), m_xWizardImpl, ShowPage(), and WZS_INVALID_STATE.

◆ StateChanged()

void vcl::RoadmapWizard::StateChanged ( StateChangedType nStateChange )

overridevirtual

Reimplemented from Dialog.

Definition at line 413 of file wizardmachine.cxx.

References CalcAndSetSize(), ImplGetPage(), ImplPosCtrls(), ImplPosTabPage(), ImplShowTabPage(), InitShow, vcl::Window::IsDefaultSize(), mnCurLevel, nType, and Dialog::StateChanged().

◆ suspendTraveling()

void vcl::RoadmapWizard::suspendTraveling ( AccessGuard )

Definition at line 784 of file wizardmachine.cxx.

References DBG_ASSERT, and m_xWizardImpl.

◆ travelNext()

void vcl::RoadmapWizard::travelNext ( )

private

travel to the next state

Definition at line 708 of file wizardmachine.cxx.

References determineNextState(), getCurrentState(), m_xWizardImpl, ShowPage(), and WZS_INVALID_STATE.

◆ travelPrevious()

void vcl::RoadmapWizard::travelPrevious ( )

private

travel to the previous state

Definition at line 725 of file wizardmachine.cxx.

References DBG_ASSERT, m_xWizardImpl, and ShowPage().

Member Data Documentation

◆ m_pCancel

VclPtr<CancelButton> vcl::RoadmapWizard::m_pCancel

Definition at line 98 of file wizdlg.hxx.

Referenced by dispose(), and implConstruct().

◆ m_pFinish

VclPtr<OKButton> vcl::RoadmapWizard::m_pFinish

Definition at line 97 of file wizdlg.hxx.

Referenced by dispose(), and implConstruct().

◆ m_pHelp

VclPtr<HelpButton> vcl::RoadmapWizard::m_pHelp

Definition at line 101 of file wizdlg.hxx.

Referenced by dispose(), and implConstruct().

◆ m_pNextPage

VclPtr<PushButton> vcl::RoadmapWizard::m_pNextPage

Definition at line 99 of file wizdlg.hxx.

Referenced by dispose(), and implConstruct().

◆ m_pPrevPage

VclPtr<PushButton> vcl::RoadmapWizard::m_pPrevPage

Definition at line 100 of file wizdlg.hxx.

Referenced by dispose(), and implConstruct().

◆ m_xRoadmapImpl

std::unique_ptr<RoadmapWizardImpl> vcl::RoadmapWizard::m_xRoadmapImpl

private

Definition at line 106 of file wizdlg.hxx.

Referenced by createPage(), DeleteRoadmapItems(), determineNextState(), dispose(), enterState(), GetCurrentRoadmapItemID(), getStateDisplayName(), implUpdateRoadmap(), InsertRoadmapItem(), RoadmapWizard(), SelectRoadmapItemByID(), SetItemSelectHdl(), SetRoadmapHelpId(), and ShowRoadmap().

◆ m_xWizardImpl

std::unique_ptr<WizardMachineImplData> vcl::RoadmapWizard::m_xWizardImpl

private

Definition at line 104 of file wizdlg.hxx.

Referenced by dispose(), GetOrCreatePage(), implConstruct(), isTravelingSuspended(), removePageFromHistory(), resumeTraveling(), skipBackwardUntil(), skipUntil(), suspendTraveling(), travelNext(), and travelPrevious().

◆ maPageSize

Size vcl::RoadmapWizard::maPageSize

private

Definition at line 69 of file wizdlg.hxx.

Referenced by GetPageSizePixel(), and SetPageSizePixel().

◆ maWizardLayoutIdle

Idle vcl::RoadmapWizard::maWizardLayoutIdle

private

Definition at line 68 of file wizdlg.hxx.

Referenced by dispose(), queue_resize(), and RoadmapWizard().

◆ mbEmptyViewMargin

bool vcl::RoadmapWizard::mbEmptyViewMargin

private

Definition at line 78 of file wizdlg.hxx.

Referenced by ImplPosCtrls(), ImplPosTabPage(), and RoadmapWizard().

◆ mnCurLevel

sal_uInt16 vcl::RoadmapWizard::mnCurLevel

private

Definition at line 76 of file wizdlg.hxx.

Referenced by GetCurLevel(), RoadmapWizard(), ShowPage(), and StateChanged().

◆ mnLeftAlignCount

sal_Int16 vcl::RoadmapWizard::mnLeftAlignCount

private

Definition at line 77 of file wizdlg.hxx.

Referenced by ImplPosCtrls(), RoadmapWizard(), and SetLeftAlignedButtonCount().

◆ mpCurTabPage

VclPtr<TabPage> vcl::RoadmapWizard::mpCurTabPage

private

Definition at line 72 of file wizdlg.hxx.

Referenced by dispose(), ImplPosTabPage(), ImplShowTabPage(), RemovePage(), RoadmapWizard(), and SetPage().

◆ mpFirstBtn

ImplWizButtonData* vcl::RoadmapWizard::mpFirstBtn

private

Definition at line 71 of file wizdlg.hxx.

Referenced by AddButton(), dispose(), ImplCalcSize(), ImplPosCtrls(), ImplPosTabPage(), RemoveButton(), and RoadmapWizard().

◆ mpFirstPage

ImplWizPageData* vcl::RoadmapWizard::mpFirstPage

private

Definition at line 70 of file wizdlg.hxx.

Referenced by AddPage(), CalcAndSetSize(), dispose(), GetPage(), ImplGetPage(), RemovePage(), RoadmapWizard(), and SetPage().

◆ mpNextBtn

VclPtr<PushButton> vcl::RoadmapWizard::mpNextBtn

private

Definition at line 74 of file wizdlg.hxx.

Referenced by dispose(), EventNotify(), implConstruct(), and RoadmapWizard().

◆ mpPrevBtn

VclPtr<PushButton> vcl::RoadmapWizard::mpPrevBtn

private

Definition at line 73 of file wizdlg.hxx.

Referenced by dispose(), EventNotify(), implConstruct(), and RoadmapWizard().

◆ mpViewWindow

VclPtr<vcl::Window> vcl::RoadmapWizard::mpViewWindow

private

Definition at line 75 of file wizdlg.hxx.

Referenced by dispose(), ImplCalcSize(), ImplPosCtrls(), ImplPosTabPage(), and RoadmapWizard().

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

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RoadmapWizard()

◆ ~RoadmapWizard()

Member Function Documentation

◆ ActivatePage()

◆ AddButton()

◆ AddPage()

◆ CalcAndSetSize()

◆ createPage()

◆ DECL_LINK() [1/5]

◆ DECL_LINK() [2/5]

◆ DECL_LINK() [3/5]

◆ DECL_LINK() [4/5]

◆ DECL_LINK() [5/5]

◆ DeleteRoadmapItems()

◆ determineNextState()

◆ dispose()

◆ enterState()

◆ EventNotify()

◆ Finish()

◆ GetCurLevel()

◆ GetCurrentRoadmapItemID()

◆ getCurrentState()

◆ GetOrCreatePage()

◆ GetPage()

◆ GetPageSizePixel()

◆ getStateDisplayName()

◆ GetUITestFactory()

◆ ImplCalcSize()

◆ implConstruct()

◆ ImplGetPage()

◆ ImplPosCtrls()

◆ ImplPosTabPage()

◆ ImplShowTabPage()

◆ implUpdateRoadmap()

◆ InsertRoadmapItem()

◆ isTravelingSuspended()

◆ LogicalCoordinateToPixel()

◆ queue_resize()

◆ RemoveButton()

◆ RemovePage()

◆ removePageFromHistory()

◆ Resize()

◆ resumeTraveling()

◆ SelectRoadmapItemByID()

◆ SetItemSelectHdl()

◆ SetLeftAlignedButtonCount()

◆ SetPage()

◆ SetPageSizePixel()

◆ SetRoadmapHelpId()

◆ ShowPage()

◆ ShowRoadmap()

◆ skipBackwardUntil()

◆ skipUntil()

◆ StateChanged()

◆ suspendTraveling()

◆ travelNext()

◆ travelPrevious()

Member Data Documentation

◆ m_pCancel

◆ m_pFinish

◆ m_pHelp

◆ m_pNextPage

◆ m_pPrevPage

◆ m_xRoadmapImpl

◆ m_xWizardImpl

◆ maPageSize

◆ maWizardLayoutIdle

◆ mbEmptyViewMargin

◆ mnCurLevel

◆ mnLeftAlignCount

◆ mpCurTabPage

◆ mpFirstBtn