LibreOffice Module vcl (master)  1
Public Member Functions | List of all members
vcl::WidgetDrawInterface Class Reference

#include <WidgetDrawInterface.hxx>

Inheritance diagram for vcl::WidgetDrawInterface:
[legend]

Public Member Functions

virtual ~WidgetDrawInterface () COVERITY_NOEXCEPT_FALSE
 
virtual bool isNativeControlSupported (ControlType eType, ControlPart ePart)
 Query the platform layer for native control support. More...
 
virtual bool hitTestNativeControl (ControlType eType, ControlPart ePart, const tools::Rectangle &rBoundingControlRegion, const Point &aPos, bool &rIsInside)
 Query if a position is inside the native widget part. More...
 
virtual bool drawNativeControl (ControlType eType, ControlPart ePart, const tools::Rectangle &rBoundingControlRegion, ControlState eState, const ImplControlValue &aValue, const OUString &aCaptions)
 Draw the requested control. More...
 
virtual bool getNativeControlRegion (ControlType eType, ControlPart ePart, const tools::Rectangle &rBoundingControlRegion, ControlState eState, const ImplControlValue &aValue, const OUString &aCaption, tools::Rectangle &rNativeBoundingRegion, tools::Rectangle &rNativeContentRegion)
 Get the native control regions for the control part. More...
 
virtual bool updateSettings (AllSettings &rSettings)
 

Detailed Description

Definition at line 20 of file WidgetDrawInterface.hxx.

Constructor & Destructor Documentation

virtual vcl::WidgetDrawInterface::~WidgetDrawInterface ( )
inlinevirtual

Definition at line 23 of file WidgetDrawInterface.hxx.

Member Function Documentation

bool vcl::WidgetDrawInterface::drawNativeControl ( ControlType  eType,
ControlPart  ePart,
const tools::Rectangle rBoundingControlRegion,
ControlState  eState,
const ImplControlValue aValue,
const OUString &  aCaptions 
)
inlinevirtual

Draw the requested control.

Parameters
[in]eTypeThe widget type.
[in]ePartThe part of the widget.
[in]rBoundingControlRegionThe bounding rectangle of the complete control in VCL frame coordinates.
[in]eStateThe general state of the control (enabled, focused, etc.).
[in]aValueAddition control specific information.
[in]aCaptionA caption or title string (like button text etc.).
Returns
true, if the control could be drawn.

Reimplemented in WinSalGraphics, GtkSalGraphics, Qt5Graphics_Controls, vcl::FileDefinitionWidgetDraw, and vcl::CustomWidgetDraw.

Definition at line 105 of file WidgetDrawInterface.hxx.

Referenced by SalGraphics::DrawNativeControl().

bool vcl::WidgetDrawInterface::getNativeControlRegion ( ControlType  eType,
ControlPart  ePart,
const tools::Rectangle rBoundingControlRegion,
ControlState  eState,
const ImplControlValue aValue,
const OUString &  aCaption,
tools::Rectangle rNativeBoundingRegion,
tools::Rectangle rNativeContentRegion 
)
inlinevirtual

Get the native control regions for the control part.

If the return value is true, rNativeBoundingRegion contains the true bounding region covered by the control including any adornment, while rNativeContentRegion contains the area within the control that can be safely drawn into without drawing over the borders of the control.

Parameters
[in]eTypeType of the widget.
[in]ePartSpecification of the widget's part if it consists of more than one.
[in]rBoundingControlRegionThe bounding region of the control in VCL frame coordinates.
[in]eStateThe general state of the control (enabled, focused, etc.).
[in]aValueAddition control specific information.
[in]aCaptionA caption or title string (like button text etc.).
[out]rNativeBoundingRegionThe region covered by the control including any adornment.
[out]rNativeContentRegionThe region within the control that can be safely drawn into.
Returns
true, if the regions are filled.

Reimplemented in WinSalGraphics, GtkSalGraphics, Qt5Graphics_Controls, vcl::FileDefinitionWidgetDraw, and vcl::CustomWidgetDraw.

Definition at line 111 of file WidgetDrawInterface.hxx.

Referenced by SalGraphics::GetNativeControlRegion().

bool vcl::WidgetDrawInterface::hitTestNativeControl ( ControlType  eType,
ControlPart  ePart,
const tools::Rectangle rBoundingControlRegion,
const Point aPos,
bool &  rIsInside 
)
inlinevirtual

Query if a position is inside the native widget part.

Mainly used for scrollbars.

Parameters
[in]eTypeThe widget type.
[in]ePartThe part of the widget.
[in]rBoundingControlRegionThe bounding Rectangle of the complete control in VCL frame coordinates.
[in]aPosThe position to check the hit.
[out]rIsInsidetrue, if aPos was inside the native widget.
Returns
true, if the query was successful.

Reimplemented in WinSalGraphics, Qt5Graphics_Controls, vcl::FileDefinitionWidgetDraw, and vcl::CustomWidgetDraw.

Definition at line 99 of file WidgetDrawInterface.hxx.

Referenced by SalGraphics::HitTestNativeScrollbar().

bool vcl::WidgetDrawInterface::isNativeControlSupported ( ControlType  eType,
ControlPart  ePart 
)
inlinevirtual

Query the platform layer for native control support.

Parameters
[in]eTypeThe widget type.
[in]ePartThe part of the widget.
Returns
true if the platform supports native drawing of the widget type defined by part.

Reimplemented in WinSalGraphics, GtkSalGraphics, Qt5Graphics_Controls, vcl::FileDefinitionWidgetDraw, and vcl::CustomWidgetDraw.

Definition at line 97 of file WidgetDrawInterface.hxx.

Referenced by SalGraphics::IsNativeControlSupported().

bool vcl::WidgetDrawInterface::updateSettings ( AllSettings rSettings)
inlinevirtual

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