#include <frmsel.hxx>

Inheritance diagram for svx::FrameSelector:

Collaboration diagram for svx::FrameSelector:

Public Member Functions
	FrameSelector ()

virtual void	SetDrawingArea (weld::DrawingArea *pDrawingArea) override

virtual	~FrameSelector () override

void	Initialize (FrameSelFlags nFlags)
	Initializes the control, enables/disables frame borders according to flags. More...

bool	IsBorderEnabled (FrameBorderType eBorder) const
	Returns true, if the specified frame border is enabled. More...

sal_Int32	GetEnabledBorderCount () const
	Returns the number of enabled frame borders. More...

FrameBorderType	GetEnabledBorderType (sal_Int32 nIndex) const
	Returns the border type from the passed index (counts only enabled frame borders). More...

bool	SupportsDontCareState () const
	Returns true, if the control supports the "don't care" frame border state. More...

FrameBorderState	GetFrameBorderState (FrameBorderType eBorder) const
	Returns the state (visible/hidden/don't care) of the specified frame border. More...

const editeng::SvxBorderLine *	GetFrameBorderStyle (FrameBorderType eBorder) const
	Returns the style of the specified frame border, if it is visible. More...

void	ShowBorder (FrameBorderType eBorder, const editeng::SvxBorderLine *pStyle)
	Shows the specified frame border using the passed style, or hides it, if pStyle is 0. More...

void	SetBorderDontCare (FrameBorderType eBorder)
	Sets the specified frame border to "don't care" state. More...

bool	IsAnyBorderVisible () const
	Returns true, if any enabled frame border has a visible style (not "don't care"). More...

void	HideAllBorders ()
	Hides all enabled frame borders. More...

bool	GetVisibleWidth (tools::Long &rnWidth, SvxBorderLineStyle &rnStyle) const
	Returns true, if all visible frame borders have equal widths. More...

bool	GetVisibleColor (Color &rColor) const
	Returns true, if all visible frame borders have equal color. More...

const Link< LinkParamNone *, void > &	GetSelectHdl () const
	Returns the current selection handler. More...

void	SetSelectHdl (const Link< LinkParamNone *, void > &rHdl)
	Sets the passed handler that is called if the selection of the control changes. More...

bool	IsBorderSelected (FrameBorderType eBorder) const
	Returns true, if the specified frame border is selected. More...

void	SelectBorder (FrameBorderType eBorder)
	Selects or deselects the specified frame border. More...

bool	IsAnyBorderSelected () const
	Returns true, if any of the enabled frame borders is selected. More...

void	SelectAllBorders (bool bSelect)
	Selects or deselects all frame borders. More...

void	DeselectAllBorders ()
	Deselects all frame borders. More...

void	SelectAllVisibleBorders ()
	Selects or deselects all visible frame borders (ignores hidden and "don't care" borders). More...

void	SetStyleToSelection (tools::Long nWidth, SvxBorderLineStyle nStyle)
	Sets the passed line widths to all selected frame borders (in twips). More...

void	SetColorToSelection (const Color &rColor)
	Sets the passed color to all selected frame borders. More...

SvxBorderLineStyle	getCurrentStyleLineStyle () const

css::uno::Reference< css::accessibility::XAccessible >	getAccessibleParent () const

virtual css::uno::Reference< css::accessibility::XAccessible >	CreateAccessible () override

a11yrelationset	get_accessible_relation_set () const

rtl::Reference< a11y::AccFrameSelectorChild >	GetChildAccessible (FrameBorderType eBorder)
	Returns the accessibility child object of the specified frame border (if enabled). More...

css::uno::Reference< css::accessibility::XAccessible >	GetChildAccessible (sal_Int32 nIndex)
	Returns the accessibility child object with specified index (counts enabled frame borders only). More...

css::uno::Reference< css::accessibility::XAccessible >	GetChildAccessible (const Point &rPos)
	Returns the accessibility child object at the specified position (relative to control). More...

tools::Rectangle	GetClickBoundRect (FrameBorderType eBorder) const
	Returns the bounding rectangle of the specified frame border (if enabled). More...

Public Member Functions inherited from weld::CustomWidgetController
virtual css::uno::Reference< css::accessibility::XAccessible >	CreateAccessible ()

virtual void	Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)=0

virtual void	Resize ()

virtual bool	MouseButtonDown (const MouseEvent &)

virtual bool	MouseMove (const MouseEvent &)

virtual bool	MouseButtonUp (const MouseEvent &)

virtual void	GetFocus ()

virtual void	LoseFocus ()

virtual void	StyleUpdated ()

virtual bool	Command (const CommandEvent &)

virtual bool	KeyInput (const KeyEvent &)

virtual tools::Rectangle	GetFocusRect ()

virtual FactoryFunction	GetUITestFactory () const

virtual OUString	RequestHelp (tools::Rectangle &)

virtual OUString	GetHelpText () const

Size const &	GetOutputSizePixel () const

void	SetOutputSizePixel (const Size &rSize)

virtual void	SetDrawingArea (weld::DrawingArea *pDrawingArea)

weld::DrawingArea *	GetDrawingArea () const

void	Invalidate ()

void	Invalidate (const tools::Rectangle &rRect)

virtual void	Show ()

virtual void	Hide ()

void	SetCursor (void *pData)

void	GrabFocus ()

bool	HasFocus () const

bool	HasChildFocus () const

bool	IsVisible () const

bool	IsReallyVisible () const

bool	IsEnabled () const

void	Enable () const

void	Disable () const

bool	IsActive () const

int	GetTextHeight () const

int	GetTextWidth (const OUString &rText) const

OUString	GetAccessibleName () const

OUString	GetAccessibleDescription () const

void	CaptureMouse ()

bool	IsMouseCaptured () const

Point	GetPointerPosPixel () const

void	EnableRTL (bool bEnable)

bool	IsRTLEnabled () const

void	ReleaseMouse ()

void	SetPointer (PointerStyle ePointerStyle)

void	SetHelpId (const OString &rHelpId)

void	SetAccessibleName (const OUString &rName)

void	SetInputContext (const InputContext &rInputContext)

void	SetCursorRect (const tools::Rectangle &rCursorRect, int nExtTextInputWidth)

virtual int	GetSurroundingText (OUString &)

virtual bool	DeleteSurroundingText (const Selection &)

css::uno::Reference< css::datatransfer::dnd::XDropTarget >	GetDropTarget ()

css::uno::Reference< css::datatransfer::clipboard::XClipboard >	GetClipboard () const

void	SetDragDataTransferable (rtl::Reference< TransferDataContainer > &rTransferable, sal_uInt8 eDNDConstants)

virtual bool	StartDrag ()

void	set_size_request (int nWidth, int nHeight)

void	queue_resize ()

	CustomWidgetController ()

virtual	~CustomWidgetController ()

	CustomWidgetController (CustomWidgetController const &)=default

	CustomWidgetController (CustomWidgetController &&)=default

CustomWidgetController &	operator= (CustomWidgetController const &)=default

CustomWidgetController &	operator= (CustomWidgetController &&)=default

Private Member Functions
virtual void	Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect) override

virtual bool	MouseButtonDown (const MouseEvent &rMEvt) override

virtual bool	KeyInput (const KeyEvent &rKEvt) override

virtual void	GetFocus () override

virtual void	LoseFocus () override

virtual void	StyleUpdated () override

virtual void	Resize () override

Private Attributes
rtl::Reference< a11y::AccFrameSelector >	mxAccess

std::unique_ptr< FrameSelectorImpl >	mxImpl
	Pointer to accessibility object of the control. More...

Additional Inherited Members
Static Public Member Functions inherited from weld::CustomWidgetController
static bool	IsUpdateMode ()

Detailed Description

Definition at line 82 of file frmsel.hxx.

Constructor & Destructor Documentation

◆ FrameSelector()

svx::FrameSelector::FrameSelector ( )

Definition at line 836 of file frmsel.cxx.

◆ ~FrameSelector()

svx::FrameSelector::~FrameSelector ( )

overridevirtual

Definition at line 849 of file frmsel.cxx.

References mxAccess.

Member Function Documentation

◆ CreateAccessible()

Reference< XAccessible > svx::FrameSelector::CreateAccessible ( )

overridevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1041 of file frmsel.cxx.

References mxAccess.

Referenced by svx::a11y::AccFrameSelectorChild::getAccessibleParent().

◆ DeselectAllBorders()

void svx::FrameSelector::DeselectAllBorders ( )

inline

Deselects all frame borders.

Definition at line 146 of file frmsel.hxx.

Referenced by KeyInput().

◆ get_accessible_relation_set()

a11yrelationset svx::FrameSelector::get_accessible_relation_set ( ) const

inline

Definition at line 162 of file frmsel.hxx.

Referenced by svx::a11y::AccFrameSelector::getAccessibleRelationSet().

◆ getAccessibleParent()

css::uno::Reference< css::accessibility::XAccessible > svx::FrameSelector::getAccessibleParent ( ) const

inline

Definition at line 160 of file frmsel.hxx.

Referenced by svx::a11y::AccFrameSelector::getAccessibleParent().

◆ GetChildAccessible() [1/3]

Reference< XAccessible > svx::FrameSelector::GetChildAccessible ( const Point & rPos )

Returns the accessibility child object at the specified position (relative to control).

Definition at line 1069 of file frmsel.cxx.

References GetChildAccessible(), svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ GetChildAccessible() [2/3]

rtl::Reference< a11y::AccFrameSelectorChild > svx::FrameSelector::GetChildAccessible ( FrameBorderType eBorder )

Returns the accessibility child object of the specified frame border (if enabled).

Definition at line 1050 of file frmsel.cxx.

References IsBorderEnabled(), and mxImpl.

Referenced by svx::a11y::AccFrameSelector::getAccessibleAtPoint(), svx::a11y::AccFrameSelectorChild::getAccessibleAtPoint(), svx::a11y::AccFrameSelector::getAccessibleChild(), GetChildAccessible(), and SelectBorder().

◆ GetChildAccessible() [3/3]

Reference< XAccessible > svx::FrameSelector::GetChildAccessible ( sal_Int32 nIndex )

Returns the accessibility child object with specified index (counts enabled frame borders only).

Definition at line 1064 of file frmsel.cxx.

References GetChildAccessible(), GetEnabledBorderType(), and nIndex.

◆ GetClickBoundRect()

tools::Rectangle svx::FrameSelector::GetClickBoundRect ( FrameBorderType eBorder ) const

Returns the bounding rectangle of the specified frame border (if enabled).

Definition at line 1078 of file frmsel.cxx.

References svx::FrameBorder::GetClickBoundRect(), svx::FrameBorder::IsEnabled(), and mxImpl.

Referenced by svx::a11y::AccFrameSelectorChild::implGetBounds().

◆ getCurrentStyleLineStyle()

SvxBorderLineStyle svx::FrameSelector::getCurrentStyleLineStyle ( ) const

Definition at line 1035 of file frmsel.cxx.

References mxImpl.

◆ GetEnabledBorderCount()

sal_Int32 svx::FrameSelector::GetEnabledBorderCount ( ) const

Returns the number of enabled frame borders.

Definition at line 869 of file frmsel.cxx.

References mxImpl.

Referenced by svx::a11y::AccFrameSelector::getAccessibleChildCount().

◆ GetEnabledBorderType()

FrameBorderType svx::FrameSelector::GetEnabledBorderType ( sal_Int32 nIndex ) const

Returns the border type from the passed index (counts only enabled frame borders).

Definition at line 874 of file frmsel.cxx.

References mxImpl, nIndex, and svx::NONE.

Referenced by GetChildAccessible().

◆ GetFocus()

void svx::FrameSelector::GetFocus ( )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1235 of file frmsel.cxx.

References svx::BLTR, svx::Bottom, svx::Horizontal, svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), IsAnyBorderSelected(), svx::Left, mxImpl, svx::NONE, svx::Right, SelectBorder(), svx::Show, svx::TLBR, svx::Top, and svx::Vertical.

◆ GetFrameBorderState()

FrameBorderState svx::FrameSelector::GetFrameBorderState ( FrameBorderType eBorder ) const

Returns the state (visible/hidden/don't care) of the specified frame border.

Definition at line 892 of file frmsel.cxx.

References mxImpl.

◆ GetFrameBorderStyle()

const SvxBorderLine * svx::FrameSelector::GetFrameBorderStyle ( FrameBorderType eBorder ) const

Returns the style of the specified frame border, if it is visible.

Definition at line 897 of file frmsel.cxx.

References mxImpl.

◆ GetSelectHdl()

const Link< LinkParamNone *, void > & svx::FrameSelector::GetSelectHdl ( ) const

Returns the current selection handler.

Definition at line 969 of file frmsel.cxx.

References mxImpl.

Referenced by MouseButtonDown().

◆ GetVisibleColor()

bool svx::FrameSelector::GetVisibleColor ( Color & rColor ) const

Returns true, if all visible frame borders have equal color.

@descr Ignores hidden and "don't care" frame borders. On success, returns the color in the passed parameter.

Definition at line 952 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ GetVisibleWidth()

bool svx::FrameSelector::GetVisibleWidth	(	tools::Long &	rnWidth,
		SvxBorderLineStyle &	rnStyle
	)		const

Returns true, if all visible frame borders have equal widths.

@descr Ignores hidden and "don't care" frame borders. On success, returns the width in the passed parameter.

Definition at line 928 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ HideAllBorders()

void svx::FrameSelector::HideAllBorders ( )

Hides all enabled frame borders.

Definition at line 922 of file frmsel.cxx.

References svx::Hide, svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ Initialize()

void svx::FrameSelector::Initialize ( FrameSelFlags nFlags )

Initializes the control, enables/disables frame borders according to flags.

Definition at line 857 of file frmsel.cxx.

References mxImpl, and weld::CustomWidgetController::Show().

◆ IsAnyBorderSelected()

bool svx::FrameSelector::IsAnyBorderSelected ( ) const

Returns true, if any of the enabled frame borders is selected.

Definition at line 1002 of file frmsel.cxx.

References mxImpl.

Referenced by svx::FrameSelectorImpl::DrawAllTrackingRects(), and GetFocus().

◆ IsAnyBorderVisible()

bool svx::FrameSelector::IsAnyBorderVisible ( ) const

Returns true, if any enabled frame border has a visible style (not "don't care").

Definition at line 914 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), mxImpl, and svx::Show.

◆ IsBorderEnabled()

bool svx::FrameSelector::IsBorderEnabled ( FrameBorderType eBorder ) const

Returns true, if the specified frame border is enabled.

Definition at line 864 of file frmsel.cxx.

References mxImpl.

Referenced by GetChildAccessible(), and KeyInput().

◆ IsBorderSelected()

bool svx::FrameSelector::IsBorderSelected ( FrameBorderType eBorder ) const

Returns true, if the specified frame border is selected.

Definition at line 979 of file frmsel.cxx.

References mxImpl.

Referenced by svx::a11y::AccFrameSelectorChild::getAccessibleStateSet().

◆ KeyInput()

bool svx::FrameSelector::KeyInput ( const KeyEvent & rKEvt )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1183 of file frmsel.cxx.

References DeselectAllBorders(), vcl::KeyCode::GetCode(), KeyEvent::GetKeyCode(), vcl::KeyCode::GetModifier(), svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), IsBorderEnabled(), KEY_DOWN, KEY_LEFT, KEY_RIGHT, KEY_SPACE, KEY_UP, mxImpl, nCode, svx::NONE, and SelectBorder().

◆ LoseFocus()

void svx::FrameSelector::LoseFocus ( )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1268 of file frmsel.cxx.

References mxImpl.

◆ MouseButtonDown()

bool svx::FrameSelector::MouseButtonDown ( const MouseEvent & rMEvt )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1095 of file frmsel.cxx.

References Link< typename Arg, typename Ret >::Call(), svx::DontCare, MouseEvent::GetPosPixel(), GetSelectHdl(), svx::Hide, svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), MouseEvent::IsLeft(), MouseEvent::IsMod1(), MouseEvent::IsShift(), mxImpl, Point, SelectBorder(), svx::Show, and SupportsDontCareState().

◆ Paint()

void svx::FrameSelector::Paint	(	vcl::RenderContext &	rRenderContext,
		const tools::Rectangle &	rRect
	)

overrideprivatevirtual

Implements weld::CustomWidgetController.

Definition at line 1088 of file frmsel.cxx.

References weld::CustomWidgetController::HasFocus(), and mxImpl.

◆ Resize()

void svx::FrameSelector::Resize ( )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1280 of file frmsel.cxx.

References mxImpl.

◆ SelectAllBorders()

void svx::FrameSelector::SelectAllBorders ( bool bSelect )

Selects or deselects all frame borders.

Definition at line 1008 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ SelectAllVisibleBorders()

void svx::FrameSelector::SelectAllVisibleBorders ( )

Selects or deselects all visible frame borders (ignores hidden and "don't care" borders).

Definition at line 1014 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), and mxImpl.

◆ SelectBorder()

void svx::FrameSelector::SelectBorder ( FrameBorderType eBorder )

Selects or deselects the specified frame border.

Definition at line 984 of file frmsel.cxx.

References Any, GetChildAccessible(), and mxImpl.

Referenced by GetFocus(), KeyInput(), and MouseButtonDown().

◆ SetBorderDontCare()

void svx::FrameSelector::SetBorderDontCare ( FrameBorderType eBorder )

Sets the specified frame border to "don't care" state.

Definition at line 909 of file frmsel.cxx.

References svx::DontCare, and mxImpl.

◆ SetColorToSelection()

void svx::FrameSelector::SetColorToSelection ( const Color & rColor )

Sets the passed color to all selected frame borders.

Definition at line 1028 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), mxImpl, and svx::Show.

◆ SetDrawingArea()

void svx::FrameSelector::SetDrawingArea ( weld::DrawingArea * pDrawingArea )

overridevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 840 of file frmsel.cxx.

References weld::CustomWidgetController::EnableRTL(), weld::DrawingArea::get_ref_device(), Size::Height(), OutputDevice::LogicToPixel(), mxImpl, weld::Widget::set_size_request(), and Size::Width().

◆ SetSelectHdl()

void svx::FrameSelector::SetSelectHdl ( const Link< LinkParamNone *, void > & rHdl )

Sets the passed handler that is called if the selection of the control changes.

Definition at line 974 of file frmsel.cxx.

References mxImpl.

◆ SetStyleToSelection()

void svx::FrameSelector::SetStyleToSelection	(	tools::Long	nWidth,
		SvxBorderLineStyle	nStyle
	)

Sets the passed line widths to all selected frame borders (in twips).

Definition at line 1020 of file frmsel.cxx.

References svx::FrameBorderIterBase< Cont, Iter, Pred >::Is(), mxImpl, and svx::Show.

◆ ShowBorder()

void svx::FrameSelector::ShowBorder	(	FrameBorderType	eBorder,
		const editeng::SvxBorderLine *	pStyle
	)

Shows the specified frame border using the passed style, or hides it, if pStyle is 0.

Definition at line 904 of file frmsel.cxx.

References mxImpl.

◆ StyleUpdated()

void svx::FrameSelector::StyleUpdated ( )

overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1274 of file frmsel.cxx.

References mxImpl.

◆ SupportsDontCareState()

bool svx::FrameSelector::SupportsDontCareState ( ) const

Returns true, if the control supports the "don't care" frame border state.

Definition at line 887 of file frmsel.cxx.

References DontCare, and mxImpl.

Referenced by MouseButtonDown(), and svx::FrameSelectorImpl::ToggleBorderState().

Member Data Documentation

◆ mxAccess

rtl::Reference<a11y::AccFrameSelector> svx::FrameSelector::mxAccess

private

Definition at line 186 of file frmsel.hxx.

Referenced by CreateAccessible(), and ~FrameSelector().

◆ mxImpl

std::unique_ptr< FrameSelectorImpl > svx::FrameSelector::mxImpl

private

Pointer to accessibility object of the control.

Definition at line 187 of file frmsel.hxx.

Referenced by GetChildAccessible(), GetClickBoundRect(), getCurrentStyleLineStyle(), GetEnabledBorderCount(), GetEnabledBorderType(), GetFocus(), GetFrameBorderState(), GetFrameBorderStyle(), GetSelectHdl(), GetVisibleColor(), GetVisibleWidth(), HideAllBorders(), Initialize(), IsAnyBorderSelected(), IsAnyBorderVisible(), IsBorderEnabled(), IsBorderSelected(), KeyInput(), LoseFocus(), MouseButtonDown(), Paint(), Resize(), SelectAllBorders(), SelectAllVisibleBorders(), SelectBorder(), SetBorderDontCare(), SetColorToSelection(), SetDrawingArea(), SetSelectHdl(), SetStyleToSelection(), ShowBorder(), StyleUpdated(), and SupportsDontCareState().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FrameSelector()

◆ ~FrameSelector()

Member Function Documentation

◆ CreateAccessible()

◆ DeselectAllBorders()

◆ get_accessible_relation_set()

◆ getAccessibleParent()

◆ GetChildAccessible() [1/3]

◆ GetChildAccessible() [2/3]

◆ GetChildAccessible() [3/3]

◆ GetClickBoundRect()

◆ getCurrentStyleLineStyle()

◆ GetEnabledBorderCount()

◆ GetEnabledBorderType()

◆ GetFocus()

◆ GetFrameBorderState()

◆ GetFrameBorderStyle()

◆ GetSelectHdl()

◆ GetVisibleColor()

◆ GetVisibleWidth()

◆ HideAllBorders()

◆ Initialize()

◆ IsAnyBorderSelected()

◆ IsAnyBorderVisible()

◆ IsBorderEnabled()

◆ IsBorderSelected()

◆ KeyInput()

◆ LoseFocus()

◆ MouseButtonDown()

◆ Paint()

◆ Resize()

◆ SelectAllBorders()

◆ SelectAllVisibleBorders()

◆ SelectBorder()

◆ SetBorderDontCare()

◆ SetColorToSelection()

◆ SetDrawingArea()

◆ SetSelectHdl()

◆ SetStyleToSelection()

◆ ShowBorder()

◆ StyleUpdated()

◆ SupportsDontCareState()

Member Data Documentation

◆ mxAccess

◆ mxImpl