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

#include <button.hxx>

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

Public Member Functions

SAL_DLLPRIVATE void ImplSetDefButton (bool bSet)
 
SAL_DLLPRIVATE void ImplDrawPushButtonFrame (vcl::RenderContext &rRenderContext, tools::Rectangle &rRect, DrawButtonFlags nStyle)
 
SAL_DLLPRIVATE bool ImplIsDefButton () const
 
 PushButton (vcl::Window *pParent, WinBits nStyle=0)
 
virtual void MouseButtonDown (const MouseEvent &rMEvt) override
 
virtual void Tracking (const TrackingEvent &rTEvt) override
 
virtual void KeyInput (const KeyEvent &rKEvt) override
 
virtual void KeyUp (const KeyEvent &rKEvt) override
 
virtual void Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override
 
virtual void Draw (OutputDevice *pDev, const Point &rPos, SystemTextColorFlags nFlags) override
 
virtual void Resize () override
 
virtual void GetFocus () override
 
virtual void LoseFocus () override
 
virtual void StateChanged (StateChangedType nType) override
 
virtual void DataChanged (const DataChangedEvent &rDCEvt) override
 
virtual bool PreNotify (NotifyEvent &rNEvt) override
 
void Toggle ()
 
void SetSymbol (SymbolType eSymbol)
 
SymbolType GetSymbol () const
 
void SetSymbolAlign (SymbolAlign eAlign)
 
void SetDropDown (PushButtonDropdownStyle nStyle)
 
void SetState (TriState eState)
 
TriState GetState () const
 
virtual void statusChanged (const css::frame::FeatureStateEvent &rEvent) override
 Sets the button state according to the FeatureStateEvent emitted by a Uno state change. More...
 
void Check (bool bCheck=true)
 
bool IsChecked () const
 
void SetPressed (bool bPressed)
 
bool IsPressed () const
 
void EndSelection ()
 
Size CalcMinimumSize () const
 
virtual Size GetOptimalSize () const override
 
virtual bool set_property (const OString &rKey, const OUString &rValue) override
 
virtual void ShowFocus (const tools::Rectangle &rRect) override
 
void setAction (bool bIsAction)
 
bool isAction () const
 
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 Button
SAL_DLLPRIVATE DrawTextFlags ImplGetTextStyle (WinBits nWinStyle, SystemTextColorFlags nSystemTextColorFlags) const
 
SAL_DLLPRIVATE void ImplDrawAlignedImage (OutputDevice *pDev, Point &rPos, Size &rSize, sal_Int32 nImageSep, DrawTextFlags nTextStyle, tools::Rectangle *pSymbolRect=nullptr, bool bAddImageSep=false)
 
SAL_DLLPRIVATE void ImplSetFocusRect (const tools::Rectangle &rFocusRect)
 
SAL_DLLPRIVATE const tools::Rectangle & ImplGetFocusRect () const
 
SAL_DLLPRIVATE void ImplSetSymbolAlign (SymbolAlign eAlign)
 
SAL_DLLPRIVATE tools::Long ImplGetSeparatorX () const
 The x-coordinate of the vertical separator line, use in MenuButton subclass only. More...
 
SAL_DLLPRIVATE void ImplSetSeparatorX (tools::Long nX)
 
virtual ~Button () 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 Click ()
 
void SetClickHdl (const Link< Button *, void > &rLink)
 
const Link< Button *, void > & GetClickHdl () const
 
void SetCommandHandler (const OUString &aCommand, const css::uno::Reference< css::frame::XFrame > &rFrame)
 Setup handler for UNO commands so that commands like .uno:Something are handled automagically by this button. More...
 
OUString const & GetCommand () const
 
void SetModeImage (const Image &rImage)
 
Image const & GetModeImage () const
 
bool HasImage () const
 
void SetImageAlign (ImageAlign eAlign)
 
ImageAlign GetImageAlign () const
 
DrawButtonFlags GetButtonState () const
 
DrawButtonFlags & GetButtonState ()
 
void SetCustomButtonImage (const Image &rImage)
 Set an image to use as the complete render view of a custom button, instead of the usual contents of a button. More...
 
Image const & GetCustomButtonImage () const
 
bool IsSmallSymbol () const
 
void SetSmallSymbol ()
 
virtual bool set_property (const OString &rKey, const OUString &rValue) override
 
virtual void statusChanged (const css::frame::FeatureStateEvent &rEvent)
 Sets the button state according to the FeatureStateEvent emitted by a Uno state change. More...
 
virtual FactoryFunction GetUITestFactory () const 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 Control
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)
 
void LogicMouseButtonDown (const MouseEvent &rMouseEvent) override
 Same as MouseButtonDown(), but coordinates are in logic unit. used for LOK. More...
 
void LogicMouseButtonUp (const MouseEvent &rMouseEvent) override
 Same as MouseButtonUp(), but coordinates are in logic unit. used for LOK. More...
 
void LogicMouseMove (const MouseEvent &rMouseEvent) override
 Same as MouseMove(), but coordinates are in logic unit. used for LOK. 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 Point ImplFrameToOutput (const Point &rPos)
 
SAL_DLLPRIVATE void ImplGrabFocus (GetFocusFlags nFlags)
 
SAL_DLLPRIVATE void ImplGrabFocusToDocument (GetFocusFlags nFlags)
 
SAL_DLLPRIVATE void ImplInvertFocus (const tools::Rectangle &rRect)
 
SAL_DLLPRIVATE PointerStyle ImplGetMousePointer () const
 
SAL_DLLPRIVATE void ImplCallMouseMove (sal_uInt16 nMouseCode, bool bModChanged=false)
 
SAL_DLLPRIVATE void ImplGenerateMouseMove ()
 
SAL_DLLPRIVATE void ImplNotifyKeyMouseCommandEventListeners (NotifyEvent &rNEvt)
 
SAL_DLLPRIVATE void ImplNotifyIconifiedState (bool bIconified)
 
SAL_DLLPRIVATE void ImplUpdateAll ()
 
SAL_DLLPRIVATE void ImplControlFocus (GetFocusFlags nFlags=GetFocusFlags::NONE)
 
SAL_DLLPRIVATE void ImplMirrorFramePos (Point &pt) const
 
SAL_DLLPRIVATE void ImplPosSizeWindow (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, PosSizeFlags nFlags)
 
SAL_DLLPRIVATE void ImplCallResize ()
 
SAL_DLLPRIVATE void ImplCallMove ()
 
SAL_DLLPRIVATE void CompatGetFocus ()
 
SAL_DLLPRIVATE void CompatLoseFocus ()
 
SAL_DLLPRIVATE void CompatStateChanged (StateChangedType nStateChange)
 
SAL_DLLPRIVATE void CompatDataChanged (const DataChangedEvent &rDCEvt)
 
SAL_DLLPRIVATE bool CompatPreNotify (NotifyEvent &rNEvt)
 
SAL_DLLPRIVATE bool CompatNotify (NotifyEvent &rNEvt)
 
void IncModalCount ()
 
void DecModalCount ()
 
 Window (vcl::Window *pParent, WinBits nStyle=0)
 
virtual ~Window () override
 
::OutputDevice const * GetOutDev () const
 
::OutputDevice * GetOutDev ()
 
Color GetBackgroundColor () const
 
const Wallpaper & GetBackground () const
 
bool IsBackground () const
 
const MapMode & GetMapMode () const
 
void SetBackground ()
 
void SetBackground (const Wallpaper &rBackground)
 
virtual void MouseMove (const MouseEvent &rMEvt)
 
virtual void MouseButtonDown (const MouseEvent &rMEvt)
 
virtual void MouseButtonUp (const MouseEvent &rMEvt)
 
virtual void KeyInput (const KeyEvent &rKEvt)
 
virtual void KeyUp (const KeyEvent &rKEvt)
 
virtual void PrePaint (vcl::RenderContext &rRenderContext)
 
virtual void Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
 
virtual void PostPaint (vcl::RenderContext &rRenderContext)
 
void Erase (vcl::RenderContext &rRenderContext)
 
virtual void Draw (::OutputDevice *pDev, const Point &rPos, SystemTextColorFlags nFlags)
 
virtual void Move ()
 
virtual void Resize ()
 
virtual void Activate ()
 
virtual void Deactivate ()
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual void RequestHelp (const HelpEvent &rHEvt)
 
virtual void Command (const CommandEvent &rCEvt)
 
virtual void Tracking (const TrackingEvent &rTEvt)
 
virtual void StateChanged (StateChangedType nStateChange)
 
virtual void DataChanged (const DataChangedEvent &rDCEvt)
 
virtual bool PreNotify (NotifyEvent &rNEvt)
 
virtual bool EventNotify (NotifyEvent &rNEvt)
 
void AddEventListener (const Link< VclWindowEvent &, void > &rEventListener)
 
void RemoveEventListener (const Link< VclWindowEvent &, void > &rEventListener)
 
void AddChildEventListener (const Link< VclWindowEvent &, void > &rEventListener)
 
void RemoveChildEventListener (const Link< VclWindowEvent &, void > &rEventListener)
 
ImplSVEvent * PostUserEvent (const Link< void *, void > &rLink, void *pCaller=nullptr, bool bReferenceLink=false)
 
void RemoveUserEvent (ImplSVEvent *nUserEvent)
 
LanguageType GetInputLanguage () const
 
void SetStyle (WinBits nStyle)
 
WinBits GetStyle () const
 
WinBits GetPrevStyle () const
 
void SetExtendedStyle (WindowExtendedStyle nExtendedStyle)
 
WindowExtendedStyle GetExtendedStyle () const
 
void SetType (WindowType nType)
 
WindowType GetType () const
 
bool IsSystemWindow () const
 
bool IsDockingWindow () const
 
bool IsDialog () const
 
bool IsMenuFloatingWindow () const
 
bool IsToolbarFloatingWindow () const
 
bool IsTopWindow () const
 
SystemWindow * GetSystemWindow () const
 
bool SupportsDoubleBuffering () const
 Can the widget derived from this Window do the double-buffering via RenderContext properly? More...
 
void RequestDoubleBuffering (bool bRequest)
 Enable/disable double-buffering of the frame window and all its children. More...
 
void EnableAllResize ()
 
void SetBorderStyle (WindowBorderStyle nBorderStyle)
 
WindowBorderStyle GetBorderStyle () const
 
void GetBorder (sal_Int32 &rLeftBorder, sal_Int32 &rTopBorder, sal_Int32 &rRightBorder, sal_Int32 &rBottomBorder) const
 
Size CalcWindowSize (const Size &rOutSz) const
 
Size CalcOutputSize (const Size &rWinSz) const
 
tools::Long CalcTitleWidth () const
 
void EnableClipSiblings (bool bClipSiblings=true)
 
void EnableChildTransparentMode (bool bEnable=true)
 
bool IsChildTransparentModeEnabled () const
 
void SetMouseTransparent (bool bTransparent)
 
bool IsMouseTransparent () const
 
void SetPaintTransparent (bool bTransparent)
 
bool IsPaintTransparent () const
 
void SetDialogControlStart (bool bStart)
 
bool IsDialogControlStart () const
 
void SetDialogControlFlags (DialogControlFlags nFlags)
 
DialogControlFlags GetDialogControlFlags () const
 
PointerState GetPointerState ()
 
bool IsMouseOver () const
 
void SetInputContext (const InputContext &rInputContext)
 
const InputContext & GetInputContext () const
 
void PostExtTextInputEvent (VclEventId nType, const OUString &rText)
 
void EndExtTextInput ()
 
void SetCursorRect (const tools::Rectangle *pRect=nullptr, tools::Long nExtTextInputWidth=0)
 
const tools::Rectangle * GetCursorRect () const
 
tools::Long GetCursorExtTextInputWidth () const
 
void SetCompositionCharRect (const tools::Rectangle *pRect, tools::Long nCompositionLength, bool bVertical=false)
 
void UpdateSettings (const AllSettings &rSettings, bool bChild=false)
 
void NotifyAllChildren (DataChangedEvent &rDCEvt)
 
void SetPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
 
vcl::Font GetPointFont (vcl::RenderContext const &rRenderContext) const
 
void SetZoomedPointFont (vcl::RenderContext &rRenderContext, const vcl::Font &rFont)
 
tools::Long GetDrawPixel (::OutputDevice const *pDev, tools::Long nPixels) const
 
vcl::Font GetDrawPixelFont (::OutputDevice const *pDev) const
 
void SetControlFont ()
 
void SetControlFont (const vcl::Font &rFont)
 
vcl::Font GetControlFont () const
 
bool IsControlFont () const
 
void ApplyControlFont (vcl::RenderContext &rRenderContext, const vcl::Font &rDefaultFont)
 
void SetControlForeground ()
 
void SetControlForeground (const Color &rColor)
 
const Color & GetControlForeground () const
 
bool IsControlForeground () const
 
void ApplyControlForeground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
 
void SetControlBackground ()
 
void SetControlBackground (const Color &rColor)
 
const Color & GetControlBackground () const
 
bool IsControlBackground () const
 
void ApplyControlBackground (vcl::RenderContext &rRenderContext, const Color &rDefaultColor)
 
void SetParentClipMode (ParentClipMode nMode=ParentClipMode::NONE)
 
ParentClipMode GetParentClipMode () const
 
void SetWindowRegionPixel ()
 
void SetWindowRegionPixel (const vcl::Region &rRegion)
 
vcl::Region GetWindowClipRegionPixel () const
 
vcl::Region GetPaintRegion () const
 
bool IsInPaint () const
 
void ExpandPaintClipRegion (const vcl::Region &rRegion)
 
void SetParent (vcl::Window *pNewParent)
 
vcl::Window * GetParent () const
 
Dialog * GetParentDialog () const
 
bool IsAncestorOf (const vcl::Window &rWindow) const
 
void Show (bool bVisible=true, ShowFlags nFlags=ShowFlags::NONE)
 
void Hide ()
 
bool IsVisible () const
 
bool IsReallyVisible () const
 
bool IsReallyShown () const
 
bool IsInInitShow () const
 
void Enable (bool bEnable=true, bool bChild=true)
 
void Disable (bool bChild=true)
 
bool IsEnabled () const
 
void EnableInput (bool bEnable=true, bool bChild=true)
 
void EnableInput (bool bEnable, const vcl::Window *pExcludeWindow)
 
bool IsInputEnabled () const
 
void AlwaysEnableInput (bool bAlways, bool bChild=true)
 Override EnableInput. More...
 
bool IsAlwaysEnableInput () const
 returns the current AlwaysEnableInput state More...
 
bool IsInModalMode () const
 A window is in modal mode if one of its children or subchildren is a running modal window (a modal dialog) More...
 
void SetActivateMode (ActivateModeFlags nMode)
 
ActivateModeFlags GetActivateMode () const
 
void ToTop (ToTopFlags nFlags=ToTopFlags::NONE)
 
void SetZOrder (vcl::Window *pRefWindow, ZOrderFlags nFlags)
 
void EnableAlwaysOnTop (bool bEnable=true)
 
bool IsAlwaysOnTopEnabled () const
 
virtual void setPosSizePixel (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, PosSizeFlags nFlags=PosSizeFlags::All)
 
virtual void SetPosPixel (const Point &rNewPos)
 
virtual Point GetPosPixel () const
 
virtual void SetSizePixel (const Size &rNewSize)
 
virtual Size GetSizePixel () const
 
virtual void SetPosSizePixel (const Point &rNewPos, const Size &rNewSize)
 
virtual void SetOutputSizePixel (const Size &rNewSize)
 
bool IsDefaultPos () const
 
bool IsDefaultSize () const
 
Point GetOffsetPixelFrom (const vcl::Window &rWindow) const
 
Point OutputToScreenPixel (const Point &rPos) const
 
Point ScreenToOutputPixel (const Point &rPos) const
 
Point OutputToNormalizedScreenPixel (const Point &rPos) const
 
Point NormalizedScreenToOutputPixel (const Point &rPos) const
 
Point OutputToAbsoluteScreenPixel (const Point &rPos) const
 
Point AbsoluteScreenToOutputPixel (const Point &rPos) const
 
tools::Rectangle GetDesktopRectPixel () const
 
tools::Rectangle GetWindowExtentsRelative (const vcl::Window *pRelativeWindow) const
 
bool IsScrollable () const
 
virtual void Scroll (tools::Long nHorzScroll, tools::Long nVertScroll, ScrollFlags nFlags=ScrollFlags::NONE)
 
void Scroll (tools::Long nHorzScroll, tools::Long nVertScroll, const tools::Rectangle &rRect, ScrollFlags nFlags=ScrollFlags::NONE)
 
virtual void Invalidate (InvalidateFlags nFlags=InvalidateFlags::NONE)
 
virtual void Invalidate (const tools::Rectangle &rRect, InvalidateFlags nFlags=InvalidateFlags::NONE)
 
virtual void Invalidate (const vcl::Region &rRegion, InvalidateFlags nFlags=InvalidateFlags::NONE)
 
virtual void LogicInvalidate (const tools::Rectangle *pRectangle)
 Notification about some rectangle of the output device got invalidated.Used for the main document window. More...
 
virtual void PixelInvalidate (const tools::Rectangle *pRectangle)
 Notification about some rectangle of the output device got invalidated. More...
 
void Validate ()
 
bool HasPaintEvent () const
 
void PaintImmediately ()
 
void EnableDocking (bool bEnable=true)
 
void EnablePaint (bool bEnable)
 
bool IsPaintEnabled () const
 
void SetUpdateMode (bool bUpdate)
 
bool IsUpdateMode () const
 
void SetParentUpdateMode (bool bUpdate)
 
void GrabFocus ()
 
bool HasFocus () const
 
bool HasChildPathFocus (bool bSystemWindow=false) const
 
bool IsActive () const
 
bool HasActiveChildFrame () const
 
GetFocusFlags GetGetFocusFlags () const
 
void GrabFocusToDocument ()
 
VclPtr< vcl::Window > GetFocusedWindow () const
 
void SetFakeFocus (bool bFocus)
 Set this when you need to act as if the window has focus even if it doesn't. More...
 
bool IsCompoundControl () const
 
void LocalStartDrag ()
 
void CaptureMouse ()
 
void ReleaseMouse ()
 
bool IsMouseCaptured () const
 
void SetPointer (PointerStyle)
 
PointerStyle GetPointer () const
 
void EnableChildPointerOverwrite (bool bOverwrite)
 
void SetPointerPosPixel (const Point &rPos)
 
Point GetPointerPosPixel ()
 
Point GetLastPointerPosPixel ()
 
void SetLastMousePos (const Point &rPos)
 Similar to SetPointerPosPixel(), but sets the frame data's last mouse position instead. More...
 
void ShowPointer (bool bVisible)
 
void EnterWait ()
 
void LeaveWait ()
 
bool IsWait () const
 
void SetCursor (vcl::Cursor *pCursor)
 
vcl::Cursor * GetCursor () const
 
void SetZoom (const Fraction &rZoom)
 
const Fraction & GetZoom () const
 
bool IsZoom () const
 
tools::Long CalcZoom (tools::Long n) const
 
virtual void SetText (const OUString &rStr)
 
virtual OUString GetText () const
 
virtual OUString GetDisplayText () const
 
virtual const Wallpaper & GetDisplayBackground () const
 
void SetHelpText (const OUString &rHelpText)
 
const OUString & GetHelpText () const
 
void SetQuickHelpText (const OUString &rHelpText)
 
const OUString & GetQuickHelpText () const
 
void SetHelpId (const OString &)
 
const OString & GetHelpId () const
 
sal_uInt16 GetChildCount () const
 
vcl::Window * GetChild (sal_uInt16 nChild) const
 
vcl::Window * GetWindow (GetWindowType nType) const
 
bool IsChild (const vcl::Window *pWindow) const
 
bool IsWindowOrChild (const vcl::Window *pWindow, bool bSystemWindow=false) const
 
SAL_DLLPRIVATE void CollectChildren (::std::vector< vcl::Window * > &rAllChildren)
 Add all children to rAllChildren recursively. More...
 
virtual void ShowFocus (const tools::Rectangle &rRect)
 
void HideFocus ()
 
void DrawSelectionBackground (const tools::Rectangle &rRect, sal_uInt16 highlight, bool bChecked, bool bDrawBorder)
 
void ShowTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags=ShowTrackFlags::Small)
 
void HideTracking ()
 
void InvertTracking (const tools::Rectangle &rRect, ShowTrackFlags nFlags)
 
void StartTracking (StartTrackingFlags nFlags=StartTrackingFlags::NONE)
 
void EndTracking (TrackingEventFlags nFlags=TrackingEventFlags::NONE)
 
bool IsTracking () const
 
void StartAutoScroll (StartAutoScrollFlags nFlags)
 
void EndAutoScroll ()
 
bool HandleScrollCommand (const CommandEvent &rCmd, Scrollable *pHScrl, Scrollable *pVScrl)
 
virtual const SystemEnvData * GetSystemData () const
 
virtual css::uno::Reference< css::awt::XWindowPeer > GetComponentInterface (bool bCreate=true)
 
void SetComponentInterface (css::uno::Reference< css::awt::XWindowPeer > const &xIFace)
 
void SetUseFrameData (bool bUseFrameData)
 
void SetLOKNotifier (const vcl::ILibreOfficeKitNotifier *pNotifier, bool bParent=false)
 Interface to register for dialog / window tunneling. More...
 
const vcl::ILibreOfficeKitNotifier * GetLOKNotifier () const
 
vcl::LOKWindowId GetLOKWindowId () const
 
VclPtr< vcl::Window > GetParentWithLOKNotifier ()
 Find the nearest parent with LOK Notifier; can be itself if this Window has LOK notifier set. More...
 
void ReleaseLOKNotifier ()
 Indicate that LOK is not going to use this dialog any more. More...
 
virtual void DumpAsPropertyTree (tools::JsonWriter &)
 Dumps itself and potentially its children to a property tree, to be written easily to JSON. More...
 
virtual void LogicMouseButtonDown (const MouseEvent &)
 Same as MouseButtonDown(), but coordinates are in logic unit. used for LOK. More...
 
virtual void LogicMouseButtonUp (const MouseEvent &)
 Same as MouseButtonUp(), but coordinates are in logic unit. used for LOK. More...
 
virtual void LogicMouseMove (const MouseEvent &)
 Same as MouseMove(), but coordinates are in logic unit. used for LOK. More...
 
void RecordLayoutData (vcl::ControlLayoutData *pLayout, const tools::Rectangle &rRect)
 
VCLXWindow * GetWindowPeer () const
 
void SetWindowPeer (css::uno::Reference< css::awt::XWindowPeer > const &xPeer, VCLXWindow *pVCLXWindow)
 
bool IsCreatedWithToolkit () const
 
void SetCreatedWithToolkit (bool b)
 
css::uno::Reference< css::datatransfer::dnd::XDropTarget > GetDropTarget ()
 
css::uno::Reference< css::datatransfer::dnd::XDragSource > GetDragSource ()
 
css::uno::Reference< css::datatransfer::dnd::XDragGestureRecognizer > GetDragGestureRecognizer ()
 
css::uno::Reference< css::datatransfer::clipboard::XClipboard > GetClipboard ()
 
void SetClipboard (css::uno::Reference< css::datatransfer::clipboard::XClipboard > const &xClipboard)
 Sets a custom clipboard for the window's frame, instead of creating it on-demand using css::datatransfer::clipboard::SystemClipboard. More...
 
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout)
 
void set_height_request (sal_Int32 nHeightRequest)
 
sal_Int32 get_height_request () const
 
void set_width_request (sal_Int32 nWidthRequest)
 
sal_Int32 get_width_request () const
 
Size get_preferred_size () const
 
VclAlign get_halign () const
 
void set_halign (VclAlign eAlign)
 
VclAlign get_valign () const
 
void set_valign (VclAlign eAlign)
 
bool get_hexpand () const
 
void set_hexpand (bool bExpand)
 
bool get_vexpand () const
 
void set_vexpand (bool bExpand)
 
bool get_expand () const
 
void set_expand (bool bExpand)
 
bool get_fill () const
 
void set_fill (bool bFill)
 
void set_border_width (sal_Int32 nBorderWidth)
 
sal_Int32 get_border_width () const
 
void set_margin_start (sal_Int32 nWidth)
 
sal_Int32 get_margin_start () const
 
void set_margin_end (sal_Int32 nWidth)
 
sal_Int32 get_margin_end () const
 
void set_margin_top (sal_Int32 nWidth)
 
sal_Int32 get_margin_top () const
 
void set_margin_bottom (sal_Int32 nWidth)
 
sal_Int32 get_margin_bottom () const
 
VclPackType get_pack_type () const
 
void set_pack_type (VclPackType ePackType)
 
sal_Int32 get_padding () const
 
void set_padding (sal_Int32 nPadding)
 
sal_Int32 get_grid_width () const
 
void set_grid_width (sal_Int32 nCols)
 
sal_Int32 get_grid_left_attach () const
 
void set_grid_left_attach (sal_Int32 nAttach)
 
sal_Int32 get_grid_height () const
 
void set_grid_height (sal_Int32 nRows)
 
sal_Int32 get_grid_top_attach () const
 
void set_grid_top_attach (sal_Int32 nAttach)
 
bool get_secondary () const
 
void set_secondary (bool bSecondary)
 
bool get_non_homogeneous () const
 
void set_non_homogeneous (bool bNonHomogeneous)
 
virtual bool set_property (const OString &rKey, const OUString &rValue)
 
bool set_font_attribute (const OString &rKey, std::u16string_view rValue)
 
void add_to_size_group (const std::shared_ptr< VclSizeGroup > &xGroup)
 
void remove_from_all_size_groups ()
 
void add_mnemonic_label (FixedText *pLabel)
 
void remove_mnemonic_label (FixedText *pLabel)
 
const std::vector< VclPtr< FixedText > > & list_mnemonic_labels () const
 
void reorderWithinParent (sal_uInt16 nNewPosition)
 
void set_id (const OUString &rID)
 Sets an ID. More...
 
const OUString & get_id () const
 Get the ID of the window. More...
 
void EnableNativeWidget (bool bEnable=true)
 
bool IsNativeWidgetEnabled () const
 
void PaintToDevice (::OutputDevice *pDevice, const Point &rPos)
 
KeyIndicatorState GetIndicatorState () const
 Query the states of keyboard indicators - Caps Lock, Num Lock and Scroll Lock. More...
 
void SimulateKeyPress (sal_uInt16 nKeyCode) const
 
virtual OUString GetSurroundingText () const
 
virtual Selection GetSurroundingTextSelection () const
 
virtual bool DeleteSurroundingText (const Selection &rSelection)
 
virtual FactoryFunction GetUITestFactory () const
 
virtual bool IsChart () const
 
virtual bool IsStarMath () const
 
void SetHelpHdl (const Link< vcl::Window &, bool > &rLink)
 
void SetMnemonicActivateHdl (const Link< vcl::Window &, bool > &rLink)
 
void SetModalHierarchyHdl (const Link< bool, void > &rLink)
 
void SetDumpAsPropertyTreeHdl (const Link< tools::JsonWriter &, void > &rLink)
 
Size GetOutputSizePixel () const
 
tools::Rectangle GetOutputRectPixel () const
 
Point LogicToPixel (const Point &rLogicPt) const
 
Size LogicToPixel (const Size &rLogicSize) const
 
tools::Rectangle LogicToPixel (const tools::Rectangle &rLogicRect) const
 
vcl::Region LogicToPixel (const vcl::Region &rLogicRegion) const
 
Point LogicToPixel (const Point &rLogicPt, const MapMode &rMapMode) const
 
Size LogicToPixel (const Size &rLogicSize, const MapMode &rMapMode) const
 
tools::Rectangle LogicToPixel (const tools::Rectangle &rLogicRect, const MapMode &rMapMode) const
 
Point PixelToLogic (const Point &rDevicePt) const
 
Size PixelToLogic (const Size &rDeviceSize) const
 
tools::Rectangle PixelToLogic (const tools::Rectangle &rDeviceRect) const
 
tools::PolyPolygon PixelToLogic (const tools::PolyPolygon &rDevicePolyPoly) const
 
vcl::Region PixelToLogic (const vcl::Region &rDeviceRegion) const
 
Point PixelToLogic (const Point &rDevicePt, const MapMode &rMapMode) const
 
Size PixelToLogic (const Size &rDeviceSize, const MapMode &rMapMode) const
 
tools::Rectangle PixelToLogic (const tools::Rectangle &rDeviceRect, const MapMode &rMapMode) const
 
Size LogicToLogic (const Size &rSzSource, const MapMode *pMapModeSource, const MapMode *pMapModeDest) const
 
const AllSettings & GetSettings () const
 
void SetSettings (const AllSettings &rSettings)
 
void SetSettings (const AllSettings &rSettings, bool bChild)
 
tools::Rectangle GetTextRect (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle=DrawTextFlags::WordBreak, TextRectInfo *pInfo=nullptr, const vcl::ITextLayout *_pTextLayout=nullptr) const
 
float GetDPIScaleFactor () const
 
tools::Long GetOutOffXPixel () const
 
tools::Long GetOutOffYPixel () const
 
void EnableMapMode (bool bEnable=true)
 
bool IsMapModeEnabled () const
 
void SetMapMode ()
 
void SetMapMode (const MapMode &rNewMapMode)
 
virtual void EnableRTL (bool bEnable=true)
 
bool IsRTLEnabled () const
 
void SetFont (const vcl::Font &rNewFont)
 
const vcl::Font & GetFont () const
 
tools::Long GetTextWidth (const OUString &rStr, sal_Int32 nIndex=0, sal_Int32 nLen=-1, vcl::text::TextLayoutCache const *=nullptr, SalLayoutGlyphs const *const pLayoutCache=nullptr) const
 Width of the text. More...
 
tools::Long GetTextHeight () const
 Height where any character of the current font fits; in logic coordinates. More...
 
float approximate_digit_width () const
 
void SetTextColor (const Color &rColor)
 
const Color & GetTextColor () const
 
void SetTextFillColor ()
 
void SetTextFillColor (const Color &rColor)
 
Color GetTextFillColor () const
 
bool IsTextFillColor () const
 
void SetTextLineColor ()
 
void SetTextLineColor (const Color &rColor)
 
const Color & GetTextLineColor () const
 
bool IsTextLineColor () const
 
void SetOverlineColor ()
 
void SetOverlineColor (const Color &rColor)
 
const Color & GetOverlineColor () const
 
bool IsOverlineColor () const
 
void SetTextAlign (TextAlign eAlign)
 
TextAlign GetTextAlign () const
 
bool IsNativeControlSupported (ControlType nType, ControlPart nPart) const
 Query the platform layer for control support. More...
 
bool GetNativeControlRegion (ControlType nType, ControlPart nPart, const tools::Rectangle &rControlRegion, ControlState nState, const ImplControlValue &aValue, tools::Rectangle &rNativeBoundingRegion, tools::Rectangle &rNativeContentRegion) const
 Query the native control's actual drawing region (including adornment) More...
 
css::uno::Reference< css::accessibility::XAccessible > GetAccessible (bool bCreate=true)
 
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible ()
 
void SetAccessible (const css::uno::Reference< css::accessibility::XAccessible > &)
 
vcl::Window * GetAccessibleParentWindow () const
 
sal_uInt16 GetAccessibleChildWindowCount ()
 
vcl::Window * GetAccessibleChildWindow (sal_uInt16 n)
 
void SetAccessibleRole (sal_uInt16 nRole)
 
sal_uInt16 GetAccessibleRole () const
 
void SetAccessibleName (const OUString &rName)
 
OUString GetAccessibleName () const
 
void SetAccessibleDescription (const OUString &rDescr)
 
OUString GetAccessibleDescription () const
 
void SetAccessibleRelationLabeledBy (vcl::Window *pLabeledBy)
 
vcl::Window * GetAccessibleRelationLabeledBy () const
 
void SetAccessibleRelationLabelFor (vcl::Window *pLabelFor)
 
vcl::Window * GetAccessibleRelationLabelFor () const
 
vcl::Window * GetAccessibleRelationMemberOf () const
 
bool IsAccessibilityEventsSuppressed (bool bTraverseParentPath=true)
 
void SetAccessibilityEventsSuppressed (bool bSuppressed)
 
KeyEvent GetActivationKey () const
 
- Public Member Functions inherited from VclReferenceBase
void acquire () const
 
void release () const
 
sal_Int32 getRefCount () const
 
void disposeOnce ()
 
bool isDisposed () const
 

Static Public Member Functions

static SAL_DLLPRIVATE bool ImplHitTestPushButton (vcl::Window const *pDev, const Point &rPos)
 
- Static Public Member Functions inherited from vcl::Window
static SAL_DLLPRIVATE void ImplInitAppFontData (vcl::Window const *pWindow)
 
static SAL_DLLPRIVATE void ImplCalcSymbolRect (tools::Rectangle &rRect)
 
static DockingManager * GetDockingManager ()
 
static VclPtr< vcl::Window > SaveFocus ()
 
static void EndSaveFocus (const VclPtr< vcl::Window > &xFocusWin)
 
static VclPtr< vcl::Window > FindLOKWindow (vcl::LOKWindowId nWindowId)
 Find an existing Window based on the LOKWindowId. More...
 
static bool IsLOKWindowsEmpty ()
 check if LOK Window container is empty More...
 

Protected Member Functions

SAL_DLLPRIVATE void ImplInitPushButtonData ()
 
SAL_DLLPRIVATE void ImplInitSettings (bool bBackground)
 
SAL_DLLPRIVATE void ImplDrawPushButtonContent (OutputDevice *pDev, SystemTextColorFlags nSystemTextColorFlags, const tools::Rectangle &rRect, bool bMenuBtnSep, DrawButtonFlags nButtonFlags)
 
SAL_DLLPRIVATE void ImplDrawPushButton (vcl::RenderContext &rRenderContext)
 
SAL_DLLPRIVATE DrawTextFlags ImplGetTextStyle (SystemTextColorFlags nSystemTextColorFlags) const
 
SAL_DLLPRIVATE bool IsSymbol () const
 
 PushButton (const PushButton &)=delete
 
PushButton & operator= (const PushButton &)=delete
 
SAL_DLLPRIVATE void ImplInit (vcl::Window *pParent, WinBits nStyle)
 
 PushButton (WindowType nType)
 
virtual void FillLayoutData () const override
 
virtual const vcl::Font & GetCanonicalFont (const StyleSettings &_rStyle) const override
 
virtual const Color & GetCanonicalTextColor (const StyleSettings &_rStyle) const override
 
SAL_DLLPRIVATE DrawTextFlags ImplGetTextStyle (WinBits nWinStyle, SystemTextColorFlags nSystemTextColorFlags) const
 
void ImplInitSettings ()
 
- Protected Member Functions inherited from Button
 Button (WindowType nType)
 
SAL_DLLPRIVATE void ImplDrawRadioCheck (OutputDevice *pDev, WinBits nWinStyle, SystemTextColorFlags nSystemTextColorFlags, const Point &rPos, const Size &rSize, const Size &rImageSize, tools::Rectangle &rStateRect, tools::Rectangle &rMouseRect)
 
SAL_DLLPRIVATE tools::Long ImplGetImageToTextDistance () const
 
 DECL_DLLPRIVATE_STATIC_LINK (Button, dispatchCommandHandler, Button *, void)
 Handler for click, in case we want the button to handle uno commands (.uno:Something). More...
 
- Protected Member Functions inherited from Control
 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
 
- 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 ()
 

Static Protected Member Functions

static SAL_DLLPRIVATE WinBits ImplInitStyle (const vcl::Window *pPrevWindow, WinBits nStyle)
 

Protected Attributes

PushButtonDropdownStyle mnDDStyle
 
bool mbIsActive
 
- Protected Attributes inherited from Control
std::optional< vcl::ControlLayoutData > mxLayoutData
 
VclPtr< OutputDevice > mpReferenceDevice
 

Private Attributes

SymbolType meSymbol
 
TriState meState
 
bool mbPressed
 
bool mbIsAction
 

Detailed Description

Definition at line 123 of file button.hxx.

Constructor & Destructor Documentation

◆ PushButton() [1/3]

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

Definition at line 1243 of file button.cxx.

References ImplInit(), ImplInitPushButtonData(), and PUSHBUTTON.

◆ PushButton() [2/3]

PushButton::PushButton ( const PushButton &  )
protecteddelete

◆ PushButton() [3/3]

PushButton::PushButton ( WindowType  nType)
explicitprotected

Definition at line 1237 of file button.cxx.

References ImplInitPushButtonData(), and nType.

Member Function Documentation

◆ CalcMinimumSize()

Size PushButton::CalcMinimumSize ( ) const

Definition at line 1685 of file button.cxx.

References Size::AdjustHeight(), Size::AdjustWidth(), Bottom, vcl::Window::CalcWindowSize(), Button::GetImageAlign(), Button::GetModeImage(), tools::Rectangle::GetSize(), Image::GetSizePixel(), vcl::Window::GetStyle(), vcl::Window::GetText(), vcl::Window::GetTextHeight(), vcl::Window::GetTextRect(), Button::HasImage(), Size::Height(), ImplGetTextStyle(), Button::IsSmallSymbol(), IsSymbol(), MenuButton, mnDDStyle, NONE, Point, Size::setHeight(), Size::setWidth(), SplitMenuButton, Top, WB_SMALLSTYLE, and Size::Width().

Referenced by GetOptimalSize().

◆ Check()

void PushButton::Check ( bool  bCheck = true)
inline

Definition at line 223 of file button.hxx.

References SetState(), TRISTATE_FALSE, and TRISTATE_TRUE.

Referenced by MenuButtonUIObject::execute(), KeyUp(), and Tracking().

◆ DataChanged()

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

Reimplemented from vcl::Window.

Definition at line 1530 of file button.cxx.

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

◆ Draw()

void PushButton::Draw ( OutputDevice *  pDev,
const Point &  rPos,
SystemTextColorFlags  nFlags 
)
overridevirtual

Definition at line 1407 of file button.cxx.

References Checked, COL_BLACK(), DecorationView::DrawButton(), vcl::Window::GetControlBackground(), vcl::Window::GetDrawPixelFont(), OutputDevice::GetSettings(), vcl::Window::GetSettings(), vcl::Window::GetSizePixel(), AllSettings::GetStyleSettings(), vcl::Window::GetTextColor(), ImplDrawPushButtonContent(), IsChecked(), vcl::Window::IsControlBackground(), OutputDevice::LogicToPixel(), Mono, NONE, Point, OutputDevice::Pop(), OutputDevice::Push(), StyleSettings::SetFaceColor(), OutputDevice::SetFont(), OutputDevice::SetMapMode(), AllSettings::SetStyleSettings(), OutputDevice::SetTextColor(), and OutputDevice::SetTextFillColor().

◆ DumpAsPropertyTree()

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

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

Reimplemented from Button.

Definition at line 641 of file button.cxx.

References DONTKNOW, Button::DumpAsPropertyTree(), GetSymbol(), and tools::JsonWriter::put().

◆ EndSelection()

void PushButton::EndSelection ( )

Definition at line 1673 of file button.cxx.

References Cancel, vcl::Window::EndTracking(), Button::GetButtonState(), vcl::Window::Invalidate(), VclReferenceBase::isDisposed(), mbPressed, and Pressed.

Referenced by MenuButton::ExecuteMenu(), and LoseFocus().

◆ FillLayoutData()

void PushButton::FillLayoutData ( ) const
overrideprotectedvirtual

Reimplemented from Control.

Definition at line 1390 of file button.cxx.

References vcl::Window::Invalidate(), and Control::mxLayoutData.

◆ GetCanonicalFont()

const vcl::Font & PushButton::GetCanonicalFont ( const StyleSettings &  _rStyle) const
overrideprotectedvirtual

Reimplemented from Control.

Definition at line 708 of file button.cxx.

References StyleSettings::GetPushButtonFont().

◆ GetCanonicalTextColor()

const Color & PushButton::GetCanonicalTextColor ( const StyleSettings &  _rStyle) const
overrideprotectedvirtual

Reimplemented from Control.

Definition at line 713 of file button.cxx.

References StyleSettings::GetButtonTextColor().

◆ GetFocus()

void PushButton::GetFocus ( )
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1469 of file button.cxx.

References vcl::Window::GetFocus(), vcl::Window::GetFont(), Button::ImplGetFocusRect(), vcl::Window::SetInputContext(), and ShowFocus().

◆ GetOptimalSize()

Size PushButton::GetOptimalSize ( ) const
overridevirtual

Reimplemented from Control.

Definition at line 1735 of file button.cxx.

References CalcMinimumSize().

◆ GetState()

TriState PushButton::GetState ( ) const
inline

Definition at line 155 of file button.hxx.

Referenced by IsChecked().

◆ GetSymbol()

SymbolType PushButton::GetSymbol ( ) const
inline

Definition at line 149 of file button.hxx.

Referenced by DumpAsPropertyTree(), ImplDrawPushButton(), and PreNotify().

◆ ImplDrawPushButton()

void PushButton::ImplDrawPushButton ( vcl::RenderContext &  rRenderContext)
protected

Definition at line 965 of file button.cxx.

References tools::Rectangle::AdjustBottom(), tools::Rectangle::AdjustLeft(), tools::Rectangle::AdjustRight(), tools::Rectangle::AdjustTop(), ButtonDown, COMBOBOX, Combobox, tools::Rectangle::Contains(), CURRENCYBOX, DATEBOX, Default, DEFAULT, OutputDevice::DrawNativeControl(), ENABLED, Entire, Focus, FOCUSED, Generic, Button::GetButtonState(), GetFontSize(), tools::Rectangle::GetHeight(), vcl::Window::GetOutputSizePixel(), vcl::Window::GetParent(), vcl::Window::GetPointerPosPixel(), Application::GetSettings(), vcl::Window::GetStyle(), GetSymbol(), vcl::Window::GetText(), vcl::Window::GetType(), tools::Rectangle::GetWidth(), HasBackgroundTexture, vcl::Window::HasFocus(), Size::Height(), vcl::Window::HideFocus(), Highlight, ImplDrawPushButtonContent(), ImplDrawPushButtonFrame(), Button::ImplGetFocusRect(), Edit::ImplUseNativeBorder(), isAction(), IsChecked(), vcl::Window::IsControlBackground(), vcl::Window::IsMouseOver(), OutputDevice::IsNativeControlSupported(), vcl::Window::IsNativeControlSupported(), IsSymbol(), LISTBOX, Listbox, OutputDevice::LogicToPixel(), LONGCURRENCYBOX, PushButtonValue::m_bFlatButton, PushButtonValue::mbBevelButton, PushButtonValue::mbIsAction, mbIsActive, mbPressed, PushButtonValue::mbSingleLine, METRICBOX, mnDDStyle, vcl::Window::mpWindowImpl, MULTILISTBOX, NONE, nState, NUMERICBOX, PATTERNBOX, Point, Pressed, PRESSED, Pushbutton, ROLLOVER, ShowFocus(), SPIN_DOWN, SplitMenuButton, TIMEBOX, TREELISTBOX, WB_BEVELBUTTON, and WB_FLATBUTTON.

Referenced by Paint().

◆ ImplDrawPushButtonContent()

void PushButton::ImplDrawPushButtonContent ( OutputDevice *  pDev,
SystemTextColorFlags  nSystemTextColorFlags,
const tools::Rectangle &  rRect,
bool  bMenuBtnSep,
DrawButtonFlags  nButtonFlags 
)
protected

Definition at line 835 of file button.cxx.

References tools::Rectangle::AdjustRight(), tools::Rectangle::Bottom(), vcl::CLIPREGION, COL_BLACK(), Default, Disable, DecorationView::DrawSeparator(), DecorationView::DrawSymbol(), StyleSettings::GetActionButtonPressedRolloverTextColor(), StyleSettings::GetActionButtonRolloverTextColor(), StyleSettings::GetActionButtonTextColor(), StyleSettings::GetButtonPressedRolloverTextColor(), StyleSettings::GetButtonRolloverTextColor(), StyleSettings::GetButtonTextColor(), vcl::Window::GetControlForeground(), StyleSettings::GetDefaultActionButtonPressedRolloverTextColor(), StyleSettings::GetDefaultActionButtonRolloverTextColor(), StyleSettings::GetDefaultActionButtonTextColor(), StyleSettings::GetDefaultButtonPressedRolloverTextColor(), StyleSettings::GetDefaultButtonRolloverTextColor(), StyleSettings::GetDefaultButtonTextColor(), StyleSettings::GetFlatButtonPressedRolloverTextColor(), StyleSettings::GetFlatButtonRolloverTextColor(), StyleSettings::GetFlatButtonTextColor(), tools::Rectangle::GetHeight(), vcl::Window::GetSettings(), tools::Rectangle::GetSize(), vcl::Window::GetStyle(), AllSettings::GetStyleSettings(), OutputDevice::GetTextHeight(), Size::getWidth(), Highlight, Button::ImplDrawAlignedImage(), ImplGetTextStyle(), Button::ImplSetSeparatorX(), OutputDevice::IntersectClipRegion(), isAction(), vcl::Window::IsControlForeground(), vcl::Window::IsEnabled(), IsSymbol(), tools::Rectangle::Left(), MenuButton, meSymbol, mnDDStyle, Mono, NONE, Point, OutputDevice::Pop(), Pressed, OutputDevice::Push(), tools::Rectangle::Right(), tools::Rectangle::SetLeft(), OutputDevice::SetTextColor(), Size::setWidth(), SPIN_DOWN, SplitMenuButton, tools::Rectangle::Top(), tools::Rectangle::TopLeft(), WB_FLATBUTTON, and Size::Width().

Referenced by Draw(), and ImplDrawPushButton().

◆ ImplDrawPushButtonFrame()

void PushButton::ImplDrawPushButtonFrame ( vcl::RenderContext &  rRenderContext,
tools::Rectangle &  rRect,
DrawButtonFlags  nStyle 
)

Definition at line 749 of file button.cxx.

References Color::DecreaseLuminance(), DecorationView::DrawButton(), vcl::Window::GetControlBackground(), Color::GetLuminance(), OutputDevice::GetSettings(), vcl::Window::GetStyle(), AllSettings::GetStyleSettings(), Highlight, Color::IncreaseLuminance(), vcl::Window::IsControlBackground(), StyleSettings::Set3DColors(), AllSettings::SetStyleSettings(), WB_RECTSTYLE, and WB_SMALLSTYLE.

Referenced by ImplDrawPushButton().

◆ ImplGetTextStyle() [1/2]

DrawTextFlags PushButton::ImplGetTextStyle ( SystemTextColorFlags  nSystemTextColorFlags) const
protected

Definition at line 800 of file button.cxx.

References Bottom, Center, Disable, EndEllipsis, StyleSettings::GetOptions(), vcl::Window::GetSettings(), vcl::Window::GetStyle(), AllSettings::GetStyleSettings(), vcl::Window::IsEnabled(), Left, Mnemonic, Mono, MultiLine, Right, Top, VCenter, WB_BOTTOM, WB_LEFT, WB_NOLABEL, WB_RIGHT, WB_TOP, WB_WORDBREAK, and WordBreak.

Referenced by CalcMinimumSize(), and ImplDrawPushButtonContent().

◆ ImplGetTextStyle() [2/2]

DrawTextFlags Button::ImplGetTextStyle ( WinBits  nWinStyle,
SystemTextColorFlags  nSystemTextColorFlags 
) const
protected

Definition at line 52 of file button.cxx.

◆ ImplHitTestPushButton()

bool PushButton::ImplHitTestPushButton ( vcl::Window const *  pDev,
const Point &  rPos 
)
static

Definition at line 792 of file button.cxx.

References tools::Rectangle::Contains(), vcl::Window::GetOutputSizePixel(), and Point.

Referenced by MouseButtonDown(), MenuButton::MouseButtonDown(), and Tracking().

◆ ImplInit()

void PushButton::ImplInit ( vcl::Window *  pParent,
WinBits  nStyle 
)
protected

Definition at line 676 of file button.cxx.

References Button::GetButtonState(), vcl::Window::ImplInit(), ImplInitSettings(), ImplInitStyle(), NoLightBorder, and WB_NOLIGHTBORDER.

Referenced by OKButton::ImplInit(), CancelButton::ImplInit(), HelpButton::ImplInit(), MenuButton::ImplInit(), and PushButton().

◆ ImplInitPushButtonData()

void PushButton::ImplInitPushButtonData ( )
protected

Definition at line 656 of file button.cxx.

References DONTKNOW, mbIsAction, mbIsActive, mbPressed, meState, meSymbol, mnDDStyle, vcl::Window::mpWindowImpl, NONE, and TRISTATE_FALSE.

Referenced by PushButton().

◆ ImplInitSettings() [1/2]

void Control::ImplInitSettings ( )
protected

Definition at line 150 of file ctrl.cxx.

Referenced by DataChanged(), ImplInit(), and StateChanged().

◆ ImplInitSettings() [2/2]

void PushButton::ImplInitSettings ( bool  bBackground)
protected

Definition at line 718 of file button.cxx.

References vcl::Window::EnableChildTransparentMode(), Entire, vcl::Window::GetStyle(), ImplGetSVData(), Control::ImplInitSettings(), vcl::Window::IsNativeControlSupported(), ImplSVData::maNWFData, ImplSVNWFData::mbNoFocusRects, ImplSVNWFData::mbNoFocusRectsForFlatButtons, vcl::Window::mpWindowImpl, NoClip, Pushbutton, vcl::Window::SetBackground(), vcl::Window::SetPaintTransparent(), vcl::Window::SetParentClipMode(), and WB_FLATBUTTON.

◆ ImplInitStyle()

WinBits PushButton::ImplInitStyle ( const vcl::Window *  pPrevWindow,
WinBits  nStyle 
)
staticprotected

Definition at line 687 of file button.cxx.

References CANCELBUTTON, vcl::Window::GetType(), HELPBUTTON, OKBUTTON, PUSHBUTTON, WB_BOTTOM, WB_GROUP, WB_NOGROUP, WB_NOTABSTOP, WB_TABSTOP, WB_TOP, and WB_VCENTER.

Referenced by ImplInit(), and StateChanged().

◆ ImplIsDefButton()

bool PushButton::ImplIsDefButton ( ) const

Definition at line 1232 of file button.cxx.

References Default, and Button::GetButtonState().

Referenced by vcl::ImplDlgCtrlUpdateDefButton(), and ImplGetDefaultButton().

◆ ImplSetDefButton()

void PushButton::ImplSetDefButton ( bool  bSet)

Definition at line 1175 of file button.cxx.

References Size::AdjustHeight(), Size::AdjustWidth(), tools::Rectangle::Bottom(), Default, DEFAULT, ENABLED, Entire, Button::GetButtonState(), vcl::Window::GetNativeControlRegion(), vcl::Window::GetPosPixel(), vcl::Window::GetSizePixel(), Size::Height(), vcl::Window::Invalidate(), vcl::Window::IsNativeControlSupported(), tools::Rectangle::Left(), Point, Pushbutton, tools::Rectangle::Right(), vcl::Window::setPosSizePixel(), tools::Rectangle::Top(), and Size::Width().

Referenced by vcl::ImplDlgCtrlUpdateDefButton(), and StateChanged().

◆ isAction()

bool PushButton::isAction ( ) const
inline

Definition at line 177 of file button.hxx.

Referenced by ImplDrawPushButton(), ImplDrawPushButtonContent(), and ShowFocus().

◆ IsChecked()

bool PushButton::IsChecked ( ) const
inline

Definition at line 228 of file button.hxx.

References GetState(), and TRISTATE_TRUE.

Referenced by Draw(), MenuButtonUIObject::execute(), ImplDrawPushButton(), KeyUp(), and Tracking().

◆ IsPressed()

bool PushButton::IsPressed ( ) const
inline

Definition at line 162 of file button.hxx.

◆ IsSymbol()

SAL_DLLPRIVATE bool PushButton::IsSymbol ( ) const
inlineprotected

Definition at line 197 of file button.hxx.

References DONTKNOW, and IMAGE.

Referenced by CalcMinimumSize(), ImplDrawPushButton(), ImplDrawPushButtonContent(), and PreNotify().

◆ KeyInput()

void PushButton::KeyInput ( const KeyEvent &  rKEvt)
overridevirtual

Reimplemented from vcl::Window.

Reimplemented in MenuButton.

Definition at line 1333 of file button.cxx.

References Button::Click(), Button::GetButtonState(), vcl::KeyCode::GetCode(), KeyEvent::GetKeyCode(), vcl::KeyCode::GetModifier(), vcl::Window::GetStyle(), vcl::Window::Invalidate(), KEY_ESCAPE, KEY_RETURN, KEY_SPACE, vcl::Window::KeyInput(), Pressed, WB_REPEAT, and WB_TOGGLE.

Referenced by MenuButton::KeyInput().

◆ KeyUp()

void PushButton::KeyUp ( const KeyEvent &  rKEvt)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1359 of file button.cxx.

References Check(), Button::Click(), Button::GetButtonState(), vcl::KeyCode::GetCode(), KeyEvent::GetKeyCode(), vcl::Window::GetStyle(), vcl::Window::Invalidate(), IsChecked(), KEY_RETURN, KEY_SPACE, vcl::Window::KeyUp(), Pressed, Toggle(), WB_REPEAT, and WB_TOGGLE.

◆ LoseFocus()

void PushButton::LoseFocus ( )
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1476 of file button.cxx.

References EndSelection(), vcl::Window::HideFocus(), and vcl::Window::LoseFocus().

◆ MouseButtonDown()

void PushButton::MouseButtonDown ( const MouseEvent &  rMEvt)
overridevirtual

Reimplemented from vcl::Window.

Reimplemented in MenuButton, and ImplBtn.

Definition at line 1250 of file button.cxx.

References ButtonRepeat, Button::Click(), Button::GetButtonState(), MouseEvent::GetPosPixel(), vcl::Window::GetStyle(), ImplHitTestPushButton(), vcl::Window::Invalidate(), MouseEvent::IsLeft(), NONE, Pressed, vcl::Window::StartTracking(), WB_REPEAT, and WB_TOGGLE.

Referenced by MenuButton::MouseButtonDown().

◆ operator=()

PushButton & PushButton::operator= ( const PushButton &  )
protecteddelete

◆ Paint()

void PushButton::Paint ( vcl::RenderContext &  rRenderContext,
const tools::Rectangle &  rRect 
)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1396 of file button.cxx.

References OutputDevice::DrawImage(), Button::GetCustomButtonImage(), ImplDrawPushButton(), and Point.

◆ PreNotify()

bool PushButton::PreNotify ( NotifyEvent &  rNEvt)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1544 of file button.cxx.

References Border, ButtonDown, COMBOBOX, Combobox, CURRENCYBOX, DATEBOX, Entire, Generic, NotifyEvent::GetMouseEvent(), vcl::Window::GetOutputSizePixel(), vcl::Window::GetParent(), vcl::Window::GetStyle(), GetSymbol(), vcl::Window::GetText(), NotifyEvent::GetType(), vcl::Window::GetType(), vcl::Window::GetWindow(), vcl::Window::Invalidate(), MouseEvent::IsEnterWindow(), MouseEvent::IsLeaveWindow(), vcl::Window::IsNativeControlSupported(), IsSymbol(), LISTBOX, Listbox, LONGCURRENCYBOX, METRICBOX, MOUSEMOVE, MULTILISTBOX, NoErase, NUMERICBOX, vcl::Window::OutputToScreenPixel(), PATTERNBOX, Point, vcl::Window::PreNotify(), Pushbutton, vcl::Window::ScreenToOutputPixel(), tools::Rectangle::SetPos(), SPIN_DOWN, TIMEBOX, tools::Rectangle::TopLeft(), TREELISTBOX, and WB_FLATBUTTON.

◆ Resize()

void PushButton::Resize ( )
overridevirtual

Reimplemented from Control.

Definition at line 1463 of file button.cxx.

References vcl::Window::Invalidate(), and Control::Resize().

Referenced by DropdownBox::DropdownBox().

◆ set_property()

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

Reimplemented from Button.

Definition at line 1740 of file button.cxx.

References vcl::Window::GetStyle(), Button::set_property(), vcl::Window::SetStyle(), toBool(), and WB_DEFBUTTON.

◆ setAction()

void PushButton::setAction ( bool  bIsAction)
inline

Definition at line 172 of file button.hxx.

◆ SetDropDown()

void PushButton::SetDropDown ( PushButtonDropdownStyle  nStyle)

Definition at line 1625 of file button.cxx.

References vcl::Window::CompatStateChanged(), Data, and mnDDStyle.

Referenced by VclBuilder::makeObject().

◆ SetPressed()

void PushButton::SetPressed ( bool  bPressed)

Definition at line 1664 of file button.cxx.

References vcl::Window::CompatStateChanged(), Data, and mbPressed.

Referenced by vcl::RoadmapWizard::EventNotify(), MenuButton::ExecuteMenu(), ListBox::PreNotify(), statusChanged(), and ListBox::ToggleDropDown().

◆ SetState()

void PushButton::SetState ( TriState  eState)

Definition at line 1634 of file button.cxx.

References Checked, vcl::Window::CompatStateChanged(), DontKnow, Button::GetButtonState(), meState, State, Toggle(), TRISTATE_FALSE, and TRISTATE_TRUE.

Referenced by Check().

◆ SetSymbol()

void PushButton::SetSymbol ( SymbolType  eSymbol)

Definition at line 1611 of file button.cxx.

References vcl::Window::CompatStateChanged(), Data, psp::eSymbol, and meSymbol.

Referenced by DropdownBox::DropdownBox(), ImplInitDropDownButton(), MenuBarWindow::MenuBarWindow(), MenuBarWindow::Resize(), and VclBuilder::VclBuilder().

◆ SetSymbolAlign()

void PushButton::SetSymbolAlign ( SymbolAlign  eAlign)

Definition at line 1620 of file button.cxx.

References Button::ImplSetSymbolAlign().

◆ ShowFocus()

void PushButton::ShowFocus ( const tools::Rectangle &  rRect)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1755 of file button.cxx.

References OutputDevice::DrawNativeControl(), Focus, FOCUSED, vcl::Window::GetOutDev(), vcl::Window::GetOutputSizePixel(), isAction(), vcl::Window::IsNativeControlSupported(), PushButtonValue::mbIsAction, Point, Pushbutton, and vcl::Window::ShowFocus().

Referenced by GetFocus(), and ImplDrawPushButton().

◆ StateChanged()

void PushButton::StateChanged ( StateChangedType  nType)
overridevirtual

Reimplemented from Control.

Reimplemented in HelpButton.

Definition at line 1483 of file button.cxx.

References ControlBackground, ControlFont, ControlForeground, Data, Enable, vcl::Window::GetPrevStyle(), vcl::Window::GetStyle(), vcl::Window::GetWindow(), ImplInitSettings(), ImplInitStyle(), ImplSetDefButton(), vcl::Window::Invalidate(), vcl::Window::IsReallyVisible(), vcl::Window::IsUpdateMode(), nType, Prev, PUSHBUTTON_VIEW_STYLE, vcl::Window::SetStyle(), State, Control::StateChanged(), Style, Text, UpdateMode, WB_DEFBUTTON, and Zoom.

Referenced by HelpButton::StateChanged().

◆ statusChanged()

void PushButton::statusChanged ( const css::frame::FeatureStateEvent &  rEvent)
overridevirtual

Sets the button state according to the FeatureStateEvent emitted by a Uno state change.

Reimplemented from Button.

Definition at line 1657 of file button.cxx.

References SetPressed(), and Button::statusChanged().

◆ Toggle()

void PushButton::Toggle ( )

Definition at line 1606 of file button.cxx.

References Control::ImplCallEventListenersAndHandler(), and PushbuttonToggle.

Referenced by MenuButtonUIObject::execute(), KeyUp(), and SetState().

◆ Tracking()

void PushButton::Tracking ( const TrackingEvent &  rTEvt)
overridevirtual

Reimplemented from vcl::Window.

Definition at line 1270 of file button.cxx.

References Check(), Button::Click(), Button::GetButtonState(), TrackingEvent::GetMouseEvent(), MouseEvent::GetPosPixel(), vcl::Window::GetStyle(), vcl::Window::GrabFocus(), ImplHitTestPushButton(), vcl::Window::Invalidate(), IsChecked(), TrackingEvent::IsTrackingCanceled(), TrackingEvent::IsTrackingEnded(), TrackingEvent::IsTrackingRepeat(), Pressed, WB_NOPOINTERFOCUS, WB_REPEAT, and WB_TOGGLE.

Member Data Documentation

◆ mbIsAction

bool PushButton::mbIsAction
private

Definition at line 220 of file button.hxx.

Referenced by ImplInitPushButtonData().

◆ mbIsActive

bool PushButton::mbIsActive
protected

Definition at line 186 of file button.hxx.

Referenced by MenuToggleButton::GetActive(), ImplDrawPushButton(), ImplInitPushButtonData(), and MenuToggleButton::SetActive().

◆ mbPressed

bool PushButton::mbPressed
private

Definition at line 219 of file button.hxx.

Referenced by EndSelection(), ImplDrawPushButton(), ImplInitPushButtonData(), and SetPressed().

◆ meState

TriState PushButton::meState
private

Definition at line 218 of file button.hxx.

Referenced by ImplInitPushButtonData(), and SetState().

◆ meSymbol

SymbolType PushButton::meSymbol
private

Definition at line 217 of file button.hxx.

Referenced by ImplDrawPushButtonContent(), ImplInitPushButtonData(), and SetSymbol().

◆ mnDDStyle

PushButtonDropdownStyle PushButton::mnDDStyle
protected

Definition at line 185 of file button.hxx.

Referenced by CalcMinimumSize(), ImplDrawPushButton(), ImplDrawPushButtonContent(), ImplInitPushButtonData(), MenuButton::MenuButton(), and SetDropDown().

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