LibreOffice Module svx (master)  1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
svx::FrameSelector Class Referencefinal

#include <frmsel.hxx>

Inheritance diagram for svx::FrameSelector:
[legend]
Collaboration diagram for svx::FrameSelector:
[legend]

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::SvxBorderLineGetFrameBorderStyle (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 (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 (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...
 
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::AccFrameSelectorChildGetChildAccessible (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 bool MouseMove (const MouseEvent &)
 
virtual bool MouseButtonUp (const MouseEvent &)
 
virtual bool Command (const CommandEvent &)
 
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)
 
weld::DrawingAreaGetDrawingArea () const
 
void Invalidate ()
 
void Invalidate (const tools::Rectangle &rRect)
 
virtual void Show ()
 
virtual void Hide ()
 
void GrabFocus ()
 
bool HasFocus () const
 
bool IsVisible () const
 
bool IsReallyVisible () const
 
bool IsEnabled () const
 
bool IsActive () const
 
int GetTextHeight () const
 
OUString GetAccessibleName () const
 
OUString GetAccessibleDescription () const
 
void CaptureMouse ()
 
bool IsMouseCaptured () 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 set_size_request (int nWidth, int nHeight)
 
void queue_resize ()
 
 CustomWidgetController ()
 
virtual ~CustomWidgetController ()
 
 CustomWidgetController (CustomWidgetController const &)=default
 
 CustomWidgetController (CustomWidgetController &&)=default
 
CustomWidgetControlleroperator= (CustomWidgetController const &)=default
 
CustomWidgetControlleroperator= (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::AccFrameSelectormxAccess
 
std::unique_ptr< FrameSelectorImplmxImpl
 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

svx::FrameSelector::FrameSelector ( )

Definition at line 818 of file frmsel.cxx.

svx::FrameSelector::~FrameSelector ( )
overridevirtual

Definition at line 831 of file frmsel.cxx.

References mxAccess.

Member Function Documentation

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

Reimplemented from weld::CustomWidgetController.

Definition at line 1014 of file frmsel.cxx.

References mxAccess.

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

void svx::FrameSelector::DeselectAllBorders ( )
inline

Deselects all frame borders.

Definition at line 146 of file frmsel.hxx.

Referenced by KeyInput().

a11yrelationset svx::FrameSelector::get_accessible_relation_set ( ) const
inline

Definition at line 160 of file frmsel.hxx.

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

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

Definition at line 158 of file frmsel.hxx.

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

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

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

Definition at line 1021 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().

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

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

Definition at line 1035 of file frmsel.cxx.

References GetChildAccessible(), and GetEnabledBorderType().

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

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

Definition at line 1040 of file frmsel.cxx.

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

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

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

Definition at line 1049 of file frmsel.cxx.

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

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

sal_Int32 svx::FrameSelector::GetEnabledBorderCount ( ) const

Returns the number of enabled frame borders.

Definition at line 849 of file frmsel.cxx.

References mxImpl.

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

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

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

Definition at line 854 of file frmsel.cxx.

References mxImpl, and svx::NONE.

Referenced by GetChildAccessible().

void svx::FrameSelector::GetFocus ( )
overrideprivatevirtual
FrameBorderState svx::FrameSelector::GetFrameBorderState ( FrameBorderType  eBorder) const

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

Definition at line 872 of file frmsel.cxx.

References mxImpl.

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

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

Definition at line 877 of file frmsel.cxx.

References mxImpl.

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

Returns the current selection handler.

Definition at line 949 of file frmsel.cxx.

References mxImpl.

Referenced by MouseButtonDown().

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

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

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

Definition at line 932 of file frmsel.cxx.

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

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

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

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

Definition at line 908 of file frmsel.cxx.

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

void svx::FrameSelector::HideAllBorders ( )

Hides all enabled frame borders.

Definition at line 902 of file frmsel.cxx.

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

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

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

Definition at line 837 of file frmsel.cxx.

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

bool svx::FrameSelector::IsAnyBorderSelected ( ) const

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

Definition at line 980 of file frmsel.cxx.

References mxImpl.

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

bool svx::FrameSelector::IsAnyBorderVisible ( ) const

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

Definition at line 894 of file frmsel.cxx.

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

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

Returns true, if the specified frame border is enabled.

Definition at line 844 of file frmsel.cxx.

References mxImpl.

Referenced by GetChildAccessible(), and KeyInput().

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

Returns true, if the specified frame border is selected.

Definition at line 959 of file frmsel.cxx.

References mxImpl.

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

bool svx::FrameSelector::KeyInput ( const KeyEvent rKEvt)
overrideprivatevirtual
void svx::FrameSelector::LoseFocus ( )
overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1239 of file frmsel.cxx.

References mxImpl.

bool svx::FrameSelector::MouseButtonDown ( const MouseEvent rMEvt)
overrideprivatevirtual
void svx::FrameSelector::Paint ( vcl::RenderContext rRenderContext,
const tools::Rectangle rRect 
)
overrideprivatevirtual

Implements weld::CustomWidgetController.

Definition at line 1059 of file frmsel.cxx.

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

void svx::FrameSelector::Resize ( )
overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1251 of file frmsel.cxx.

References mxImpl.

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

Selects or deselects all frame borders.

Definition at line 986 of file frmsel.cxx.

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

void svx::FrameSelector::SelectAllVisibleBorders ( )

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

Definition at line 992 of file frmsel.cxx.

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

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

Selects or deselects the specified frame border.

Definition at line 964 of file frmsel.cxx.

References Any, GetChildAccessible(), and mxImpl.

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

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

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

Definition at line 889 of file frmsel.cxx.

References svx::DontCare, and mxImpl.

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

Sets the passed color to all selected frame borders.

Definition at line 1006 of file frmsel.cxx.

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

void svx::FrameSelector::SetDrawingArea ( weld::DrawingArea pDrawingArea)
overridevirtual
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 954 of file frmsel.cxx.

References mxImpl.

void svx::FrameSelector::SetStyleToSelection ( long  nWidth,
SvxBorderLineStyle  nStyle 
)

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

Definition at line 998 of file frmsel.cxx.

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

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 884 of file frmsel.cxx.

References mxImpl.

void svx::FrameSelector::StyleUpdated ( )
overrideprivatevirtual

Reimplemented from weld::CustomWidgetController.

Definition at line 1245 of file frmsel.cxx.

References mxImpl.

bool svx::FrameSelector::SupportsDontCareState ( ) const

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

Definition at line 867 of file frmsel.cxx.

References svx::DontCare, and mxImpl.

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

Member Data Documentation

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

Definition at line 184 of file frmsel.hxx.

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

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

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