LibreOffice Module vcl (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VclBox Class Referenceabstract

#include <layout.hxx>

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

Public Member Functions

 VclBox (vcl::Window *pParent, bool bHomogeneous, int nSpacing)
 
void set_spacing (int nSpacing)
 
int get_spacing () const
 
void set_homogeneous (bool bHomogeneous)
 
bool get_orientation () const
 
virtual bool set_property (const OUString &rKey, const OUString &rValue) override
 
virtual void DumpAsPropertyTree (tools::JsonWriter &) override
 Dumps itself and potentially its children to a property tree, to be written easily to JSON. More...
 
- Public Member Functions inherited from VclContainer
 VclContainer (vcl::Window *pParent, WinBits nStyle=WB_HIDE|WB_CLIPCHILDREN)
 
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout) override
 
virtual Size GetOptimalSize () const override
 
virtual void SetPosSizePixel (const Point &rNewPos, const Size &rNewSize) override
 
virtual void SetPosPixel (const Point &rAllocPos) override
 
virtual void SetSizePixel (const Size &rAllocation) override
 
- Public Member Functions inherited from vcl::Window
 DECL_DLLPRIVATE_LINK (ImplHandlePaintHdl, Timer *, void)
 
 DECL_DLLPRIVATE_LINK (ImplGenerateMouseMoveHdl, void *, void)
 
 DECL_DLLPRIVATE_LINK (ImplTrackTimerHdl, Timer *, void)
 
 DECL_DLLPRIVATE_LINK (ImplAsyncFocusHdl, void *, void)
 
 DECL_DLLPRIVATE_LINK (ImplHandleResizeTimerHdl, Timer *, void)
 
SAL_DLLPRIVATE vcl::WindowImplGetFrameWindow () const
 
weld::WindowGetFrameWeld () const
 
vcl::WindowGetFrameWindow () const
 
SalFrameImplGetFrame () const
 
SAL_DLLPRIVATE ImplFrameDataImplGetFrameData ()
 
vcl::WindowImplGetWindow () const
 if this is a proxy return the client, otherwise itself More...
 
SAL_DLLPRIVATE ImplWinDataImplGetWinData () const
 
SAL_DLLPRIVATE vcl::WindowImplGetClientWindow () const
 
SAL_DLLPRIVATE vcl::WindowImplGetDlgWindow (sal_uInt16 n, GetDlgWindowType nType, sal_uInt16 nStart=0, sal_uInt16 nEnd=0xFFFF, sal_uInt16 *pIndex=nullptr)
 
SAL_DLLPRIVATE vcl::WindowImplGetParent () const
 
SAL_DLLPRIVATE vcl::WindowImplFindWindow (const Point &rFramePos)
 
SAL_DLLPRIVATE void ImplInvalidateFrameRegion (const vcl::Region *pRegion, InvalidateFlags nFlags)
 
SAL_DLLPRIVATE void ImplInvalidateOverlapFrameRegion (const vcl::Region &rRegion)
 
SAL_DLLPRIVATE bool ImplSetClipFlag (bool bSysObjOnlySmaller=false)
 
SAL_DLLPRIVATE bool ImplIsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
 
SAL_DLLPRIVATE bool ImplIsChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
 
SAL_DLLPRIVATE bool ImplIsFloatingWindow () const
 
SAL_DLLPRIVATE bool ImplIsPushButton () const
 
SAL_DLLPRIVATE bool ImplIsSplitter () const
 
SAL_DLLPRIVATE bool ImplIsOverlapWindow () const
 
SAL_DLLPRIVATE void ImplIsInTaskPaneList (bool mbIsInTaskList)
 
SAL_DLLPRIVATE WindowImplImplGetWindowImpl () const
 
SAL_DLLPRIVATE 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
 
::OutputDeviceGetOutDev ()
 
Color GetBackgroundColor () const
 
const WallpaperGetBackground () const
 
bool IsBackground () const
 
const MapModeGetMapMode () const
 
void SetBackground ()
 
void SetBackground (const Wallpaper &rBackground)
 
virtual void MouseMove (const MouseEvent &rMEvt)
 
virtual void MouseButtonDown (const MouseEvent &rMEvt)
 
virtual void MouseButtonUp (const MouseEvent &rMEvt)
 
virtual void KeyInput (const KeyEvent &rKEvt)
 
virtual void KeyUp (const KeyEvent &rKEvt)
 
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)
 
ImplSVEventPostUserEvent (const Link< void *, void > &rLink, void *pCaller=nullptr, bool bReferenceLink=false)
 
void RemoveUserEvent (ImplSVEvent *nUserEvent)
 
LanguageType GetInputLanguage () const
 
void SetStyle (WinBits nStyle)
 
WinBits GetStyle () const
 
WinBits GetPrevStyle () const
 
void SetExtendedStyle (WindowExtendedStyle nExtendedStyle)
 
WindowExtendedStyle GetExtendedStyle () const
 
void SetType (WindowType nType)
 
WindowType GetType () const
 
bool IsSystemWindow () const
 
bool IsDockingWindow () const
 
bool IsDialog () const
 
bool IsMenuFloatingWindow () const
 
bool IsToolbarFloatingWindow () const
 
bool IsTopWindow () const
 
SystemWindowGetSystemWindow () const
 
bool SupportsDoubleBuffering () const
 Can the widget derived from this Window do the double-buffering via RenderContext properly? More...
 
void RequestDoubleBuffering (bool bRequest)
 Enable/disable double-buffering of the frame window and all its children. More...
 
void EnableAllResize ()
 
void SetBorderStyle (WindowBorderStyle nBorderStyle)
 
WindowBorderStyle GetBorderStyle () const
 
void GetBorder (sal_Int32 &rLeftBorder, sal_Int32 &rTopBorder, sal_Int32 &rRightBorder, sal_Int32 &rBottomBorder) const
 
Size CalcWindowSize (const Size &rOutSz) const
 
Size CalcOutputSize (const Size &rWinSz) const
 
tools::Long CalcTitleWidth () const
 
void EnableClipSiblings (bool bClipSiblings=true)
 
void EnableChildTransparentMode (bool bEnable=true)
 
bool IsChildTransparentModeEnabled () const
 
void SetMouseTransparent (bool bTransparent)
 
bool IsMouseTransparent () const
 
void SetPaintTransparent (bool bTransparent)
 
bool IsPaintTransparent () const
 
void SetDialogControlStart (bool bStart)
 
bool IsDialogControlStart () const
 
void SetDialogControlFlags (DialogControlFlags nFlags)
 
DialogControlFlags GetDialogControlFlags () const
 
PointerState GetPointerState ()
 
bool IsMouseOver () const
 
void SetInputContext (const InputContext &rInputContext)
 
const InputContextGetInputContext () const
 
void PostExtTextInputEvent (VclEventId nType, const OUString &rText)
 
void EndExtTextInput ()
 
void SetCursorRect (const tools::Rectangle *pRect=nullptr, tools::Long nExtTextInputWidth=0)
 
const tools::RectangleGetCursorRect () const
 
tools::Long GetCursorExtTextInputWidth () const
 
void SetCompositionCharRect (const tools::Rectangle *pRect, tools::Long nCompositionLength, bool bVertical=false)
 
void UpdateSettings (const AllSettings &rSettings, bool bChild=false)
 
void NotifyAllChildren (DataChangedEvent &rDCEvt)
 
void SetPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
 
vcl::Font GetPointFont (vcl::RenderContext const &rRenderContext) const
 
void SetZoomedPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
 
tools::Long GetDrawPixel (::OutputDevice const *pDev, tools::Long nPixels) const
 
vcl::Font GetDrawPixelFont (::OutputDevice const *pDev) const
 
void SetControlFont ()
 
void SetControlFont (const vcl::Font &rFont)
 
vcl::Font GetControlFont () const
 
bool IsControlFont () const
 
void ApplyControlFont (vcl::RenderContext &rRenderContext, const vcl::Font &rDefaultFont)
 
void SetControlForeground ()
 
void SetControlForeground (const Color &rColor)
 
const ColorGetControlForeground () const
 
bool IsControlForeground () const
 
void ApplyControlForeground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
 
void SetControlBackground ()
 
void SetControlBackground (const Color &rColor)
 
const ColorGetControlBackground () const
 
bool IsControlBackground () const
 
void ApplyControlBackground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
 
void SetParentClipMode (ParentClipMode nMode=ParentClipMode::NONE)
 
ParentClipMode GetParentClipMode () const
 
void SetWindowRegionPixel ()
 
void SetWindowRegionPixel (const vcl::Region &rRegion)
 
vcl::Region GetWindowClipRegionPixel () const
 
vcl::Region GetPaintRegion () const
 
bool IsInPaint () const
 
void ExpandPaintClipRegion (const vcl::Region &rRegion)
 
void SetParent (vcl::Window *pNewParent)
 
vcl::WindowGetParent () const
 
DialogGetParentDialog () const
 
bool IsAncestorOf (const vcl::Window &rWindow) const
 
void Show (bool bVisible=true, ShowFlags nFlags=ShowFlags::NONE)
 
void Hide ()
 
bool IsVisible () const
 
bool IsReallyVisible () const
 
bool IsReallyShown () const
 
bool IsInInitShow () const
 
void Enable (bool bEnable=true, bool bChild=true)
 
void Disable (bool bChild=true)
 
bool IsEnabled () const
 
void EnableInput (bool bEnable=true, bool bChild=true)
 
void EnableInput (bool bEnable, const vcl::Window *pExcludeWindow)
 
bool IsInputEnabled () const
 
void AlwaysEnableInput (bool bAlways, bool bChild=true)
 Override EnableInput. More...
 
bool IsAlwaysEnableInput () const
 returns the current AlwaysEnableInput state More...
 
bool IsInModalMode () const
 A window is in modal mode if one of its children or subchildren is a running modal window (a modal dialog) More...
 
void SetActivateMode (ActivateModeFlags nMode)
 
ActivateModeFlags GetActivateMode () const
 
void ToTop (ToTopFlags nFlags=ToTopFlags::NONE)
 
void SetZOrder (vcl::Window *pRefWindow, ZOrderFlags nFlags)
 
void EnableAlwaysOnTop (bool bEnable=true)
 
bool IsAlwaysOnTopEnabled () const
 
virtual void setPosSizePixel (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, PosSizeFlags nFlags=PosSizeFlags::All)
 
virtual void SetPosPixel (const Point &rNewPos)
 
virtual Point GetPosPixel () const
 
virtual void SetSizePixel (const Size &rNewSize)
 
virtual Size GetSizePixel () const
 
virtual void SetPosSizePixel (const Point &rNewPos, const Size &rNewSize)
 
virtual void SetOutputSizePixel (const Size &rNewSize)
 
bool IsDefaultPos () const
 
bool IsDefaultSize () const
 
Point GetOffsetPixelFrom (const vcl::Window &rWindow) const
 
Point OutputToScreenPixel (const Point &rPos) const
 
Point ScreenToOutputPixel (const Point &rPos) const
 
Point OutputToNormalizedScreenPixel (const Point &rPos) const
 
Point NormalizedScreenToOutputPixel (const Point &rPos) const
 
Point OutputToAbsoluteScreenPixel (const Point &rPos) const
 
Point AbsoluteScreenToOutputPixel (const Point &rPos) const
 
tools::Rectangle GetDesktopRectPixel () const
 
tools::Rectangle GetWindowExtentsRelative (const vcl::Window &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::WindowGetFocusedWindow () const
 
void SetFakeFocus (bool bFocus)
 Set this when you need to act as if the window has focus even if it doesn't. More...
 
bool IsCompoundControl () const
 
void 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::CursorGetCursor () const
 
void SetZoom (const Fraction &rZoom)
 
const FractionGetZoom () 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 WallpaperGetDisplayBackground () 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::WindowGetChild (sal_uInt16 nChild) const
 
vcl::WindowGetWindow (GetWindowType nType) const
 
bool IsChild (const vcl::Window *pWindow) const
 
bool IsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
 
SAL_DLLPRIVATE void CollectChildren (::std::vector< vcl::Window * > &rAllChildren)
 Add all children to rAllChildren recursively. More...
 
virtual void ShowFocus (const tools::Rectangle &rRect)
 
void HideFocus ()
 
void DrawSelectionBackground (const tools::Rectangle &rRect, sal_uInt16 highlight, bool bChecked, bool bDrawBorder)
 
void ShowTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags=ShowTrackFlags::Small)
 
void HideTracking ()
 
void InvertTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags)
 
void StartTracking (StartTrackingFlags nFlags=StartTrackingFlags::NONE)
 
void EndTracking (TrackingEventFlags nFlags=TrackingEventFlags::NONE)
 
bool IsTracking () const
 
void StartAutoScroll (StartAutoScrollFlags nFlags)
 
void EndAutoScroll ()
 
bool HandleScrollCommand (const CommandEvent &rCmd, Scrollable *pHScrl, Scrollable *pVScrl)
 
virtual const SystemEnvDataGetSystemData () 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::ILibreOfficeKitNotifierGetLOKNotifier () const
 
vcl::LOKWindowId GetLOKWindowId () const
 
VclPtr< vcl::WindowGetParentWithLOKNotifier ()
 Find the nearest parent with LOK Notifier; can be itself if this Window has LOK notifier set. More...
 
void ReleaseLOKNotifier ()
 Indicate that LOK is not going to use this dialog any more. More...
 
virtual void DumpAsPropertyTree (tools::JsonWriter &)
 Dumps itself and potentially its children to a property tree, to be written easily to JSON. More...
 
void RecordLayoutData (vcl::ControlLayoutData *pLayout, const tools::Rectangle &rRect)
 
VCLXWindowGetWindowPeer () 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 AllSettingsGetSettings () const
 
void SetSettings (const AllSettings &rSettings)
 
void SetSettings (const AllSettings &rSettings, bool bChild)
 
tools::Rectangle GetTextRect (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle=DrawTextFlags::WordBreak, TextRectInfo *pInfo=nullptr, const vcl::ITextLayout *_pTextLayout=nullptr) const
 
float GetDPIScaleFactor () const
 
tools::Long GetOutOffXPixel () const
 
tools::Long GetOutOffYPixel () const
 
void EnableMapMode (bool bEnable=true)
 
bool IsMapModeEnabled () const
 
void SetMapMode ()
 
void SetMapMode (const MapMode &rNewMapMode)
 
virtual void EnableRTL (bool bEnable=true)
 
bool IsRTLEnabled () const
 
void SetFont (const vcl::Font &rNewFont)
 
const vcl::FontGetFont () const
 
tools::Long GetTextWidth (const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, vcl::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 ColorGetTextColor () const
 
void SetTextFillColor ()
 
void SetTextFillColor (const Color &rColor)
 
Color GetTextFillColor () const
 
bool IsTextFillColor () const
 
void SetTextLineColor ()
 
void SetTextLineColor (const Color &rColor)
 
const ColorGetTextLineColor () const
 
bool IsTextLineColor () const
 
void SetOverlineColor ()
 
void SetOverlineColor (const Color &rColor)
 
const ColorGetOverlineColor () const
 
bool IsOverlineColor () const
 
void SetTextAlign (TextAlign eAlign)
 
TextAlign GetTextAlign () const
 
bool IsNativeControlSupported (ControlType nType, ControlPart nPart) const
 Query the platform layer for control support. More...
 
bool GetNativeControlRegion (ControlType nType, ControlPart nPart, const tools::Rectangle &rControlRegion, ControlState nState, const ImplControlValue &aValue, tools::Rectangle &rNativeBoundingRegion, tools::Rectangle &rNativeContentRegion) const
 Query the native control's actual drawing region (including adornment) More...
 
css::uno::Reference< css::accessibility::XAccessible > GetAccessible (bool bCreate=true)
 
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible ()
 
void SetAccessible (const css::uno::Reference< css::accessibility::XAccessible > &)
 
vcl::WindowGetAccessibleParentWindow () const
 
sal_uInt16 GetAccessibleChildWindowCount ()
 
vcl::WindowGetAccessibleChildWindow (sal_uInt16 n)
 
void SetAccessibleRole (sal_uInt16 nRole)
 
sal_uInt16 GetAccessibleRole () const
 
void SetAccessibleName (const OUString &rName)
 
OUString GetAccessibleName () const
 
void SetAccessibleDescription (const OUString &rDescr)
 
OUString GetAccessibleDescription () const
 
void SetAccessibleRelationLabeledBy (vcl::Window *pLabeledBy)
 
vcl::WindowGetAccessibleRelationLabeledBy () const
 
void SetAccessibleRelationLabelFor (vcl::Window *pLabelFor)
 
vcl::WindowGetAccessibleRelationLabelFor () const
 
vcl::WindowGetAccessibleRelationMemberOf () const
 
bool IsAccessibilityEventsSuppressed (bool bTraverseParentPath=true)
 
void SetAccessibilityEventsSuppressed (bool bSuppressed)
 
KeyEvent GetActivationKey () const
 
- Public Member Functions inherited from VclReferenceBase
void acquire () const
 
void release () const
 
sal_Int32 getRefCount () const
 
void disposeOnce ()
 
bool isDisposed () const
 

Protected Member Functions

virtual sal_uInt16 getDefaultAccessibleRole () const override
 
void accumulateMaxes (const Size &rChildSize, Size &rSize) const
 
Size finalizeMaxes (const Size &rSize, sal_uInt16 nVisibleChildren) const
 
virtual Size calculateRequisition () const override
 
virtual void setAllocation (const Size &rAllocation) override
 
virtual tools::Long getPrimaryDimension (const Size &rSize) const =0
 
virtual void setPrimaryDimension (Size &rSize, tools::Long) const =0
 
virtual tools::Long getPrimaryCoordinate (const Point &rPos) const =0
 
virtual void setPrimaryCoordinate (Point &rPos, tools::Long) const =0
 
virtual tools::Long getSecondaryDimension (const Size &rSize) const =0
 
virtual void setSecondaryDimension (Size &rSize, tools::Long) const =0
 
virtual bool getPrimaryDimensionChildExpand (const vcl::Window &rWindow) const =0
 
- Protected Member Functions inherited from VclContainer
virtual Size calculateRequisition () const =0
 
virtual void setAllocation (const Size &rAllocation)=0
 
virtual sal_uInt16 getDefaultAccessibleRole () const override
 
virtual void Command (const CommandEvent &rCEvt) override
 
- 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::WindowImplGetBorderWindow () 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::WindowgetLegacyNonLayoutAccessibleRelationMemberOf () const
 
SAL_DLLPRIVATE vcl::WindowgetLegacyNonLayoutAccessibleRelationLabeledBy () const
 
SAL_DLLPRIVATE vcl::WindowgetLegacyNonLayoutAccessibleRelationLabelFor () const
 
virtual vcl::WindowgetAccessibleRelationLabelFor () 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

bool m_bHomogeneous
 
bool m_bVerticalContainer
 
int m_nSpacing
 

Additional Inherited Members

- Static Public Member Functions inherited from VclContainer
static Size getLayoutRequisition (const vcl::Window &rWindow)
 
static void setLayoutPosSize (vcl::Window &rWindow, const Point &rPos, const Size &rSize)
 
static void setLayoutAllocation (vcl::Window &rWindow, const Point &rPos, const Size &rSize)
 
- Static Public Member Functions inherited from vcl::Window
static SAL_DLLPRIVATE void ImplInitAppFontData (vcl::Window const *pWindow)
 
static SAL_DLLPRIVATE void ImplCalcSymbolRect (tools::Rectangle &rRect)
 
static DockingManagerGetDockingManager ()
 
static VclPtr< vcl::WindowSaveFocus ()
 
static void EndSaveFocus (const VclPtr< vcl::Window > &xFocusWin)
 
static VclPtr< vcl::WindowFindLOKWindow (vcl::LOKWindowId nWindowId)
 Find an existing Window based on the LOKWindowId. More...
 
static bool IsLOKWindowsEmpty ()
 check if LOK Window container is empty More...
 

Detailed Description

Definition at line 70 of file layout.hxx.

Constructor & Destructor Documentation

◆ VclBox()

VclBox::VclBox ( vcl::Window pParent,
bool  bHomogeneous,
int  nSpacing 
)
inline

Definition at line 77 of file layout.hxx.

Member Function Documentation

◆ accumulateMaxes()

void VclBox::accumulateMaxes ( const Size rChildSize,
Size rSize 
) const
protected

◆ calculateRequisition()

Size VclBox::calculateRequisition ( ) const
overrideprotectedvirtual

◆ DumpAsPropertyTree()

void VclBox::DumpAsPropertyTree ( tools::JsonWriter rJsonWriter)
overridevirtual

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

Reimplemented from vcl::Window.

Reimplemented in VclButtonBox.

Definition at line 396 of file layout.cxx.

References vcl::Window::DumpAsPropertyTree(), m_bVerticalContainer, and tools::JsonWriter::put().

Referenced by VclButtonBox::DumpAsPropertyTree().

◆ finalizeMaxes()

Size VclBox::finalizeMaxes ( const Size rSize,
sal_uInt16  nVisibleChildren 
) const
protected

◆ get_orientation()

bool VclBox::get_orientation ( ) const
inline

Definition at line 96 of file layout.hxx.

Referenced by sort_native_button_order().

◆ get_spacing()

int VclBox::get_spacing ( ) const
inline

Definition at line 88 of file layout.hxx.

Referenced by PriorityHBox::Resize(), and PriorityMergedHBox::Resize().

◆ getDefaultAccessibleRole()

sal_uInt16 VclBox::getDefaultAccessibleRole ( ) const
overrideprotectedvirtual

Reimplemented from VclContainer.

Definition at line 402 of file layout.cxx.

References Application::GetToolkitName().

◆ getPrimaryCoordinate()

virtual tools::Long VclBox::getPrimaryCoordinate ( const Point rPos) const
protectedpure virtual

◆ getPrimaryDimension()

virtual tools::Long VclBox::getPrimaryDimension ( const Size rSize) const
protectedpure virtual

◆ getPrimaryDimensionChildExpand()

virtual bool VclBox::getPrimaryDimensionChildExpand ( const vcl::Window rWindow) const
protectedpure virtual

Implemented in VclVBox, VclHBox, VclVButtonBox, and VclHButtonBox.

Referenced by setAllocation().

◆ getSecondaryDimension()

virtual tools::Long VclBox::getSecondaryDimension ( const Size rSize) const
protectedpure virtual

◆ set_homogeneous()

void VclBox::set_homogeneous ( bool  bHomogeneous)
inline

Definition at line 92 of file layout.hxx.

Referenced by set_property().

◆ set_property()

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

Reimplemented from vcl::Window.

Reimplemented in VclButtonBox.

Definition at line 385 of file layout.cxx.

References set_homogeneous(), vcl::Window::set_property(), set_spacing(), and toBool().

Referenced by VclButtonBox::set_property().

◆ set_spacing()

void VclBox::set_spacing ( int  nSpacing)
inline

Definition at line 84 of file layout.hxx.

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

◆ setAllocation()

void VclBox::setAllocation ( const Size rAllocation)
overrideprotectedvirtual

◆ setPrimaryCoordinate()

virtual void VclBox::setPrimaryCoordinate ( Point rPos,
tools::Long   
) const
protectedpure virtual

◆ setPrimaryDimension()

virtual void VclBox::setPrimaryDimension ( Size rSize,
tools::Long   
) const
protectedpure virtual

◆ setSecondaryDimension()

virtual void VclBox::setSecondaryDimension ( Size rSize,
tools::Long   
) const
protectedpure virtual

Member Data Documentation

◆ m_bHomogeneous

bool VclBox::m_bHomogeneous
protected

◆ m_bVerticalContainer

bool VclBox::m_bVerticalContainer
protected

Definition at line 74 of file layout.hxx.

Referenced by DumpAsPropertyTree().

◆ m_nSpacing

int VclBox::m_nSpacing
protected

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