#include <ctrl.hxx>

Inheritance diagram for Control:

Collaboration diagram for Control:

Public Member Functions
SAL_DLLPRIVATE void	ImplClearLayoutData () const

SAL_DLLPRIVATE void	ImplDrawFrame (OutputDevice *pDev, tools::Rectangle &rRect)
	draws a frame around the give rectangle, onto the given device More...

	Control (vcl::Window *pParent, WinBits nWinStyle=0)

virtual	~Control () 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	EnableRTL (bool bEnable=true) override

virtual bool	EventNotify (NotifyEvent &rNEvt) override

virtual void	StateChanged (StateChangedType nStateChange) override

virtual void	Resize () override

virtual void	SetText (const OUString &rStr) override

virtual OUString	GetDisplayText () const override

tools::Rectangle	GetCharacterBounds (tools::Long nIndex) const

tools::Long	GetIndexForPoint (const Point &rPoint) const

Pair	GetLineStartEnd (tools::Long nLine) const

tools::Long	ToRelativeLineIndex (tools::Long nIndex) const
	ToRelativeLineIndex changes a layout data index to a count relative to its line. More...

void	SetLoseFocusHdl (const Link< Control &, void > &rLink)

bool	HasControlFocus () const
	determines whether the control currently has the focus More...

void	SetLayoutDataParent (const Control *pParent) const

virtual Size	GetOptimalSize () const override

void	SetReferenceDevice (OutputDevice *_referenceDevice)
	sets a reference device used for rendering control text More...

OutputDevice *	GetReferenceDevice () const

vcl::Font	GetUnzoomedControlPointFont () const

void	SetShowAccelerator (bool val)

virtual void	LogicInvalidate (const tools::Rectangle *pRectangle) override
	Notify the LOK client about an invalidated area. More...

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 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 &rRelativeWindow) const

tools::Rectangle	GetWindowExtentsAbsolute () 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)

void	Invalidate (InvalidateFlags nFlags=InvalidateFlags::NONE)

void	Invalidate (const tools::Rectangle &rRect, InvalidateFlags nFlags=InvalidateFlags::NONE)

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

virtual 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 OUString &)

const OUString &	GetHelpId () const

sal_uInt16	GetChildCount () const

vcl::Window *	GetChild (sal_uInt16 nChild) const

vcl::Window *	GetWindow (GetWindowType nType) const

bool	IsChild (const vcl::Window *pWindow) const

bool	IsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const

SAL_DLLPRIVATE void	CollectChildren (::std::vector< vcl::Window * > &rAllChildren)
	Add all children to rAllChildren recursively. More...

virtual void	ShowFocus (const tools::Rectangle &rRect)

void	HideFocus ()

void	DrawSelectionBackground (const tools::Rectangle &rRect, sal_uInt16 highlight, bool bChecked, bool bDrawBorder)

void	ShowTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags=ShowTrackFlags::Small)

void	HideTracking ()

void	InvertTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags)

void	StartTracking (StartTrackingFlags nFlags=StartTrackingFlags::NONE)

void	EndTracking (TrackingEventFlags nFlags=TrackingEventFlags::NONE)

bool	IsTracking () const

void	StartAutoScroll (StartAutoScrollFlags nFlags)

void	EndAutoScroll ()

bool	HandleScrollCommand (const CommandEvent &rCmd, Scrollable pHScrl, Scrollable pVScrl)

virtual const SystemEnvData *	GetSystemData () const

virtual css::uno::Reference< css::awt::XVclWindowPeer >	GetComponentInterface (bool bCreate=true)

void	SetComponentInterface (css::uno::Reference< css::awt::XVclWindowPeer > 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...

void	RecordLayoutData (vcl::ControlLayoutData *pLayout, const tools::Rectangle &rRect)

VCLXWindow *	GetWindowPeer () const

void	SetWindowPeer (css::uno::Reference< css::awt::XVclWindowPeer > 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 OUString &rKey, const OUString &rValue)

bool	set_font_attribute (const OUString &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

Protected Member Functions
	Control (WindowType nType)

virtual void	FillLayoutData () const

void	AppendLayoutData (const Control &rSubControl) const

void	CreateLayoutData () const
	creates the mpData->mpLayoutData structure More...

bool	HasLayoutData () const
	determines whether we currently have layout data More...

bool	ImplCallEventListenersAndHandler (VclEventId nEvent, std::function< void()> const &callHandler)
	this calls both our event listeners, and a specified handler More...

void	CallEventListeners (VclEventId nEvent, void *pData=nullptr)

tools::Rectangle	DrawControlText (OutputDevice &_rTargetDevice, const tools::Rectangle &_rRect, const OUString &_rStr, DrawTextFlags _nStyle, std::vector< tools::Rectangle > _pVector, OUString _pDisplayText, const Size *i_pDeviceSize=nullptr) const
	draws the given text onto the given device More...

tools::Rectangle	GetControlTextRect (OutputDevice &_rTargetDevice, const tools::Rectangle &rRect, const OUString &_rStr, DrawTextFlags _nStyle, Size *o_pDeviceSize=nullptr) const

virtual const vcl::Font &	GetCanonicalFont (const StyleSettings &_rStyle) const

virtual const Color &	GetCanonicalTextColor (const StyleSettings &_rStyle) const

void	ImplInitSettings ()

virtual void	ApplySettings (vcl::RenderContext &rRenderContext) override

virtual bool	FocusWindowBelongsToControl (const vcl::Window *pFocusWin) const

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

virtual void	ImplInvalidate (const vcl::Region *pRegion, 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
std::optional< vcl::ControlLayoutData >	mxLayoutData

VclPtr< OutputDevice >	mpReferenceDevice

Private Member Functions
SAL_DLLPRIVATE void	ImplInitControlData ()

	Control (const Control &)=delete

Control &	operator= (const Control &)=delete

Private Attributes
bool	mbHasControlFocus

bool	mbShowAccelerator

Link< Control &, void >	maLoseFocusHdl

Additional Inherited Members
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...

Detailed Description

Definition at line 79 of file ctrl.hxx.

Constructor & Destructor Documentation

◆ Control() [1/3]

Control::Control ( const Control & )

privatedelete

◆ Control() [2/3]

Control::Control ( WindowType nType )

protected

Definition at line 43 of file ctrl.cxx.

References ImplInitControlData(), and nType.

◆ Control() [3/3]

Control::Control	(	vcl::Window *	pParent,
		WinBits	nWinStyle = `0`
	)

explicit

Definition at line 49 of file ctrl.cxx.

References CONTROL, vcl::Window::ImplInit(), and ImplInitControlData().

◆ ~Control()

Control::~Control ( )

overridevirtual

Definition at line 56 of file ctrl.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

◆ AppendLayoutData()

void Control::AppendLayoutData ( const Control & rSubControl ) const

protected

Definition at line 269 of file ctrl.cxx.

References FillLayoutData(), vcl::Window::GetWindowExtentsRelative(), HasLayoutData(), tools::Rectangle::Left(), tools::Rectangle::Move(), mxLayoutData, n, and tools::Rectangle::Top().

Referenced by ComboBox::FillLayoutData(), ListBox::FillLayoutData(), and SpinField::FillLayoutData().

◆ ApplySettings()

void Control::ApplySettings ( vcl::RenderContext & rRenderContext )

overrideprotectedvirtual

Reimplemented from vcl::Window.

Reimplemented in SelectableFixedText, FixedLine, FixedBitmap, FixedImage, Edit, FixedText, ListBox, ScrollBar, SvTreeListBox, VclMultiLineEdit, Calendar, vcl::HyperLabel, ImplListBoxWindow, and ImplWin.

Definition at line 413 of file ctrl.cxx.

References OutputDevice::GetSettings(), AllSettings::GetStyleSettings(), and OutputDevice::SetTextFillColor().

Referenced by FixedLine::ApplySettings(), Edit::ApplySettings(), and FixedText::ApplySettings().

◆ CallEventListeners()

void Control::CallEventListeners	(	VclEventId	nEvent,
		void *	pData = `nullptr`
	)

protected

Definition at line 293 of file ctrl.cxx.

References vcl::Window::CallEventListeners(), UITestLogger::getInstance(), UITestLogger::logAction(), and pData.

Referenced by SvtIconChoiceCtrl::CallImplEventListeners(), SvTreeListBox::CallImplEventListeners(), VclMultiLineEdit::CaretChanged(), ComboBox::Clear(), ListBox::Clear(), ListBox::dispose(), ComboBox::EventNotify(), Edit::GetFocus(), ImplCallEventListenersAndHandler(), Edit::ImplSetSelection(), Edit::ImplSetText(), ComboBox::InsertEntry(), ListBox::InsertEntry(), ComboBox::InsertEntryWithImage(), TabControl::InsertPage(), Edit::Modify(), VclMultiLineEdit::Modify(), ListBox::PreNotify(), ListBox::RemoveEntry(), ComboBox::RemoveEntryAt(), TabControl::RemovePage(), SvTreeListBox::Select(), ListBox::SelectEntriesPos(), ListBox::SelectEntryPos(), VclMultiLineEdit::SelectionChanged(), TabControl::SelectTabPage(), TabControl::SetPageText(), ComboBox::SetText(), ComboBox::ToggleDropDown(), and ListBox::ToggleDropDown().

◆ CreateLayoutData()

void Control::CreateLayoutData ( ) const

protected

creates the mpData->mpLayoutData structure

Definition at line 87 of file ctrl.cxx.

References mxLayoutData, and SAL_WARN_IF.

Referenced by SvtIconChoiceCtrl::FillLayoutData().

◆ dispose()

void Control::dispose ( void )

overridevirtual

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

Reimplemented from vcl::Window.

Reimplemented in InterimItemWindow, NotebookBar, TabControl, Button, RadioButton, CalendarField, ComboBox, Edit, MetricField, MetricBox, DateField, FixedText, FormattedField, SvtIconChoiceCtrl, ListBox, MenuButton, ScrollBar, SpinField, SvTabListBox, SvHeaderTabListBox, SvTreeListBox, VclMultiLineEdit, Calendar, ImplListBoxWindow, ImplListBox, and ManagedMenuButton.

Definition at line 61 of file ctrl.cxx.

References VclPtr< reference_type >::clear(), mpReferenceDevice, and mxLayoutData.

Referenced by InterimItemWindow::dispose(), NotebookBar::dispose(), TabControl::dispose(), Button::dispose(), Edit::dispose(), FixedText::dispose(), SvtIconChoiceCtrl::dispose(), ListBox::dispose(), ScrollBar::dispose(), SvTreeListBox::dispose(), Calendar::dispose(), ImplListBoxWindow::dispose(), and ImplListBox::dispose().

◆ DrawControlText()

tools::Rectangle Control::DrawControlText	(	OutputDevice &	_rTargetDevice,
		const tools::Rectangle &	_rRect,
		const OUString &	_rStr,
		DrawTextFlags	_nStyle,
		std::vector< tools::Rectangle > *	_pVector,
		OUString *	_pDisplayText,
		const Size *	i_pDeviceSize = `nullptr`
	)		const

protected

draws the given text onto the given device

If no reference device is set, the draw request will simply be forwarded to OutputDevice::DrawText. Otherwise, the text will be rendered according to the metrics at the reference device.

return will contain the result of a GetTextRect call (either directly at the target device, or taking the reference device into account) when returning.

Definition at line 428 of file ctrl.cxx.

References OutputDevice::DrawText(), vcl::ControlTextRenderer::DrawText(), OutputDevice::GetTextRect(), ImplGetSVData(), ImplSVData::maNWFData, ImplSVNWFData::mbAutoAccel, and removeMnemonicFromString().

Referenced by FixedText::ImplDraw(), FixedLine::ImplDraw(), Button::ImplDrawAlignedImage(), and TabControl::ImplDrawItem().

◆ EnableRTL()

void Control::EnableRTL ( bool bEnable = true )

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in SvTreeListBox.

Definition at line 68 of file ctrl.cxx.

References vcl::text::BiDiRtl, vcl::Window::CompatStateChanged(), vcl::Window::GetOutDev(), Mirroring, OutputDevice::SetLayoutMode(), and vcl::text::TextOriginLeft.

Referenced by SvTreeListBox::EnableRTL(), MenuButton::ImplInit(), SpinField::ImplInit(), Edit::ImplInitEditData(), ListBox::StateChanged(), and ImplListBox::StateChanged().

◆ EventNotify()

bool Control::EventNotify ( NotifyEvent & rNEvt )

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in TabControl, ComboBox, MetricField, MetricBox, DateField, FormattedField, SpinField, VclMultiLineEdit, and ImplListBox.

Definition at line 225 of file ctrl.cxx.

References ControlFocus, ControlGetFocus, ControlLoseFocus, vcl::Window::EventNotify(), GETFOCUS, Application::GetFocusWindow(), NotifyEvent::GetType(), and LOSEFOCUS.

Referenced by TabControl::EventNotify(), ComboBox::EventNotify(), SpinField::EventNotify(), and VclMultiLineEdit::EventNotify().

◆ FillLayoutData()

void Control::FillLayoutData ( ) const

protectedvirtual

Reimplemented in PushButton, CheckBox, RadioButton, ComboBox, Edit, FixedText, FixedLine, SvtIconChoiceCtrl, ListBox, SpinField, ImplListBoxWindow, and ImplWin.

Definition at line 83 of file ctrl.cxx.

Referenced by AppendLayoutData().

◆ FocusWindowBelongsToControl()

bool Control::FocusWindowBelongsToControl ( const vcl::Window * pFocusWin ) const

protectedvirtual

Reimplemented in CalendarField.

Definition at line 220 of file ctrl.cxx.

Referenced by CalendarField::FocusWindowBelongsToControl().

◆ GetCanonicalFont()

const vcl::Font & Control::GetCanonicalFont ( const StyleSettings & _rStyle ) const

protectedvirtual

Reimplemented in TabControl, PushButton, CheckBox, RadioButton, FixedText, and FixedLine.

Definition at line 403 of file ctrl.cxx.

References StyleSettings::GetLabelFont().

◆ GetCanonicalTextColor()

const Color & Control::GetCanonicalTextColor ( const StyleSettings & _rStyle ) const

protectedvirtual

Reimplemented in TabControl, PushButton, CheckBox, RadioButton, FixedText, and FixedLine.

Definition at line 408 of file ctrl.cxx.

References StyleSettings::GetLabelTextColor().

◆ GetCharacterBounds()

tools::Rectangle Control::GetCharacterBounds ( tools::Long nIndex ) const

Definition at line 113 of file ctrl.cxx.

References nIndex.

Referenced by SvtIconChoiceCtrl::GetEntryCharacterBounds().

◆ GetControlTextRect()

tools::Rectangle Control::GetControlTextRect	(	OutputDevice &	_rTargetDevice,
		const tools::Rectangle &	rRect,
		const OUString &	_rStr,
		DrawTextFlags	_nStyle,
		Size *	o_pDeviceSize = `nullptr`
	)		const

protected

Definition at line 450 of file ctrl.cxx.

References tools::Rectangle::GetSize(), vcl::ControlTextRenderer::GetTextRect(), OutputDevice::GetTextRect(), ImplGetSVData(), ImplSVData::maNWFData, ImplSVNWFData::mbAutoAccel, and removeMnemonicFromString().

Referenced by Button::ImplDrawAlignedImage().

◆ GetDisplayText()

OUString Control::GetDisplayText ( ) const

overridevirtual

Reimplemented from vcl::Window.

Definition at line 213 of file ctrl.cxx.

Referenced by ButtonUIObject::get_state(), and MenuButtonUIObject::get_state().

◆ GetIndexForPoint()

tools::Long Control::GetIndexForPoint ( const Point & rPoint ) const

Definition at line 137 of file ctrl.cxx.

Referenced by ComboBox::GetIndexForPoint(), and ListBox::GetIndexForPoint().

◆ GetLineStartEnd()

Pair Control::GetLineStartEnd ( tools::Long nLine ) const

Definition at line 167 of file ctrl.cxx.

Referenced by SvtIconChoiceCtrl::GetEntryCharacterBounds().

◆ GetOptimalSize()

Size Control::GetOptimalSize ( ) const

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in InterimItemWindow, NotebookBar, TabControl, PushButton, CheckBox, RadioButton, ComboBox, Edit, FixedText, FixedLine, FixedImage, ListBox, ScrollBar, SpinField, SvTreeListBox, and Calendar.

Definition at line 369 of file ctrl.cxx.

Referenced by NotebookBar::GetOptimalSize(), and VclBuilder::VclBuilder().

◆ GetReferenceDevice()

OutputDevice * Control::GetReferenceDevice ( ) const

Definition at line 384 of file ctrl.cxx.

◆ GetUnzoomedControlPointFont()

Font Control::GetUnzoomedControlPointFont ( ) const

Definition at line 476 of file ctrl.cxx.

References vcl::Font::Merge().

Referenced by vcl::ReferenceDeviceTextLayout::ReferenceDeviceTextLayout().

◆ HasControlFocus()

bool Control::HasControlFocus ( ) const

inline

determines whether the control currently has the focus

Definition at line 216 of file ctrl.hxx.

◆ HasLayoutData()

bool Control::HasLayoutData ( ) const

protected

determines whether we currently have layout data

Definition at line 93 of file ctrl.cxx.

References mxLayoutData.

Referenced by AppendLayoutData(), ComboBox::GetIndexForPoint(), and ListBox::GetIndexForPoint().

◆ ImplCallEventListenersAndHandler()

bool Control::ImplCallEventListenersAndHandler	(	VclEventId	nEvent,
		std::function< void()> const &	callHandler
	)

protected

this calls both our event listeners, and a specified handler

If the Control instance is destroyed during any of those calls, the method properly handles this (in particular, it doesn't crash :)

Parameters

nEvent	the event to notify to our event listeners
callHandler	the lambda function that calls the handler

Returns: if the Control instance has been destroyed in any of the call

Definition at line 301 of file ctrl.cxx.

References CallEventListeners(), and VclReferenceBase::isDisposed().

Referenced by Button::Click(), ComboBox::DoubleClick(), ListBox::DoubleClick(), SpinField::Down(), ScrollBar::EndScroll(), SpinField::First(), SpinField::Last(), Edit::Modify(), ScrollBar::Scroll(), ComboBox::Select(), ListBox::Select(), PushButton::Toggle(), CheckBox::Toggle(), RadioButton::Toggle(), and SpinField::Up().

◆ ImplClearLayoutData()

void Control::ImplClearLayoutData ( ) const

◆ ImplDrawFrame()

void Control::ImplDrawFrame	(	OutputDevice *	pDev,
		tools::Rectangle &	rRect
	)

draws a frame around the give rectangle, onto the given device

only to be used from within the Window::Draw method of your sub class.

The frame is always drawn with a single line (without 3D effects). In addition, any mono color set at the control's settings is respected. Yet more additionally, if we're living in a themed desktop, this theming is ignored.

Note that this makes sense, since the only known clients of Window::Draw are form controls, when printed or print-previewed. For form controls embedded in office documents, you don't want to have the theme look.

Parameters

pDev	the device to draw onto
rRect	the rect for drawing the frame. Upon returning from the call, the rect will be inflated by the space occupied by the drawn pixels.

Definition at line 331 of file ctrl.cxx.

References DecorationView::DrawFrame(), StyleSettings::GetOptions(), OutputDevice::GetSettings(), AllSettings::GetStyleSettings(), Mono, Out, StyleSettings::SetMonoColor(), StyleSettings::SetOptions(), AllSettings::SetStyleSettings(), and WindowBorder.

Referenced by ComboBox::Draw(), Edit::Draw(), FixedText::Draw(), FixedImage::Draw(), and ListBox::Draw().

◆ ImplInitControlData()

void Control::ImplInitControlData ( )

private

Definition at line 37 of file ctrl.cxx.

References mbHasControlFocus, and mbShowAccelerator.

Referenced by Control().

◆ ImplInitSettings()

void Control::ImplInitSettings ( )

protected

Definition at line 423 of file ctrl.cxx.

Referenced by TabControl::ImplInitSettings(), PushButton::ImplInitSettings(), CheckBox::ImplInitSettings(), and RadioButton::ImplInitSettings().

◆ LogicInvalidate()

void Control::LogicInvalidate ( const tools::Rectangle * pRectangle )

overridevirtual

Notify the LOK client about an invalidated area.

Reimplemented from vcl::Window.

Definition at line 484 of file ctrl.cxx.

References vcl::Window::GetLOKNotifier(), comphelper::LibreOfficeKit::isTiledPainting(), vcl::Window::LogicInvalidate(), OutputDevice::LogicToLogic(), and vcl::ILibreOfficeKitNotifier::notifyInvalidation().

◆ operator=()

Control & Control::operator= ( const Control & )

privatedelete

References dispose(), Resize, and SetText().

◆ Resize()

void Control::Resize ( )

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in InterimItemWindow, VclDrawingArea, NotebookBar, TabControl, PushButton, CheckBox, RadioButton, ComboBox, Edit, FixedText, FixedLine, FixedBitmap, FixedImage, SvtIconChoiceCtrl, ListBox, ScrollBar, SpinField, SvTreeListBox, VclMultiLineEdit, Calendar, IconView, ImplListBoxWindow, ImplListBox, ImplWin, and Slider.

Definition at line 77 of file ctrl.cxx.

References ImplClearLayoutData().

Referenced by InterimItemWindow::Layout(), NotebookBar::Resize(), PushButton::Resize(), CheckBox::Resize(), RadioButton::Resize(), ComboBox::Resize(), Edit::Resize(), FixedText::Resize(), FixedLine::Resize(), FixedBitmap::Resize(), FixedImage::Resize(), SvtIconChoiceCtrl::Resize(), ListBox::Resize(), ScrollBar::Resize(), SpinField::Resize(), SvTreeListBox::Resize(), Calendar::Resize(), ImplListBoxWindow::Resize(), ImplListBox::Resize(), ImplWin::Resize(), and Slider::Resize().

◆ SetLayoutDataParent()

void Control::SetLayoutDataParent ( const Control * pParent ) const

Definition at line 320 of file ctrl.cxx.

Referenced by ComboBox::FillLayoutData(), ListBox::FillLayoutData(), and SpinField::FillLayoutData().

◆ SetLoseFocusHdl()

void Control::SetLoseFocusHdl ( const Link< Control &, void > & rLink )

inline

Definition at line 212 of file ctrl.hxx.

Referenced by SalInstanceFormattedSpinButton::SalInstanceFormattedSpinButton(), SalInstanceSpinButton::SalInstanceSpinButton(), SalInstanceFormattedSpinButton::~SalInstanceFormattedSpinButton(), and SalInstanceSpinButton::~SalInstanceSpinButton().

◆ SetReferenceDevice()

void Control::SetReferenceDevice ( OutputDevice * _referenceDevice )

sets a reference device used for rendering control text

See also: DrawControlText

Definition at line 375 of file ctrl.cxx.

◆ SetShowAccelerator()

void Control::SetShowAccelerator ( bool val )

Definition at line 358 of file ctrl.cxx.

Referenced by ImplHandleControlAccelerator().

◆ SetText()

void Control::SetText ( const OUString & rStr )

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in ComboBox, Edit, FormattedField, and VclMultiLineEdit.

Definition at line 98 of file ctrl.cxx.

References ImplClearLayoutData().

Referenced by SalInstanceDialog::add_button(), CloseButton::CloseButton(), MessageDialog::create_message_area(), SvTreeListBox::EditedText(), vcl::RoadmapWizard::implConstruct(), OKButton::ImplInit(), CancelButton::ImplInit(), HelpButton::ImplInit(), VclExpander::set_label(), SalInstanceLabel::set_label(), and vcl::HyperLabel::SetLabel().

◆ StateChanged()

void Control::StateChanged ( StateChangedType nStateChange )

overridevirtual

Reimplemented from vcl::Window.

Reimplemented in NotebookBar, SvTreeListBox, InterimItemWindow, HelpButton, CalendarField, Calendar, VclDrawingArea, TabControl, PushButton, CheckBox, RadioButton, ComboBox, Edit, FixedText, FixedLine, FixedBitmap, FixedImage, ListBox, ScrollBar, SpinField, VclMultiLineEdit, ImplListBoxWindow, ImplListBox, and Slider.

Definition at line 256 of file ctrl.cxx.

References ControlFont, InitShow, vcl::Window::StateChanged(), Visible, and Zoom.

Referenced by Button::ImplSetSymbolAlign(), Button::SetCustomButtonImage(), Button::SetImageAlign(), Button::SetModeImage(), NotebookBar::StateChanged(), SvTreeListBox::StateChanged(), InterimItemWindow::StateChanged(), Calendar::StateChanged(), VclDrawingArea::StateChanged(), TabControl::StateChanged(), PushButton::StateChanged(), CheckBox::StateChanged(), RadioButton::StateChanged(), Edit::StateChanged(), FixedText::StateChanged(), FixedLine::StateChanged(), FixedBitmap::StateChanged(), FixedImage::StateChanged(), ListBox::StateChanged(), ScrollBar::StateChanged(), VclMultiLineEdit::StateChanged(), ImplListBoxWindow::StateChanged(), ImplListBox::StateChanged(), and Slider::StateChanged().

◆ ToRelativeLineIndex()

tools::Long Control::ToRelativeLineIndex ( tools::Long nIndex ) const

ToRelativeLineIndex changes a layout data index to a count relative to its line.

This is equivalent to getting the line start/end pairs with GetLineStartEnd() until the index lies within [start,end] of a line

Parameters

nIndex the absolute index inside the display text to be changed to a relative index

Returns: the relative index inside the displayed line or -1 if the absolute index does not match any line

Definition at line 206 of file ctrl.cxx.

References nIndex.

Referenced by ComboBox::GetIndexForPoint(), and ListBox::GetIndexForPoint().

Member Data Documentation

◆ maLoseFocusHdl

Link<Control&,void> Control::maLoseFocusHdl

private

Definition at line 88 of file ctrl.hxx.

◆ mbHasControlFocus

bool Control::mbHasControlFocus

private

Definition at line 86 of file ctrl.hxx.

Referenced by ImplInitControlData().

◆ mbShowAccelerator

bool Control::mbShowAccelerator

private

Definition at line 87 of file ctrl.hxx.

Referenced by ImplInitControlData().

◆ mpReferenceDevice

VclPtr<OutputDevice> Control::mpReferenceDevice

protected

Definition at line 83 of file ctrl.hxx.

Referenced by dispose().

◆ mxLayoutData

std::optional<vcl::ControlLayoutData> Control::mxLayoutData

mutableprotected

Definition at line 82 of file ctrl.hxx.

Referenced by AppendLayoutData(), CreateLayoutData(), dispose(), ImplWin::DrawEntry(), PushButton::FillLayoutData(), CheckBox::FillLayoutData(), RadioButton::FillLayoutData(), ComboBox::FillLayoutData(), Edit::FillLayoutData(), FixedText::FillLayoutData(), FixedLine::FillLayoutData(), ListBox::FillLayoutData(), SpinField::FillLayoutData(), ImplListBoxWindow::FillLayoutData(), ImplWin::FillLayoutData(), HasLayoutData(), and FixedText::ImplDraw().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Control() [1/3]

◆ Control() [2/3]

◆ Control() [3/3]

◆ ~Control()

Member Function Documentation

◆ AppendLayoutData()

◆ ApplySettings()

◆ CallEventListeners()

◆ CreateLayoutData()

◆ dispose()

◆ DrawControlText()

◆ EnableRTL()

◆ EventNotify()

◆ FillLayoutData()

◆ FocusWindowBelongsToControl()

◆ GetCanonicalFont()

◆ GetCanonicalTextColor()

◆ GetCharacterBounds()

◆ GetControlTextRect()

◆ GetDisplayText()

◆ GetIndexForPoint()

◆ GetLineStartEnd()

◆ GetOptimalSize()

◆ GetReferenceDevice()

◆ GetUnzoomedControlPointFont()

◆ HasControlFocus()

◆ HasLayoutData()

◆ ImplCallEventListenersAndHandler()

◆ ImplClearLayoutData()

◆ ImplDrawFrame()

◆ ImplInitControlData()

◆ ImplInitSettings()

◆ LogicInvalidate()

◆ operator=()

◆ Resize()

◆ SetLayoutDataParent()

◆ SetLoseFocusHdl()

◆ SetReferenceDevice()

◆ SetShowAccelerator()

◆ SetText()

◆ StateChanged()

◆ ToRelativeLineIndex()

Member Data Documentation

◆ maLoseFocusHdl

◆ mbHasControlFocus

◆ mbShowAccelerator

◆ mpReferenceDevice

◆ mxLayoutData