LibreOffice Module chart2 (master) 1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
chart::wrapper::LegendItemConverter Class Referencefinal

#include <LegendItemConverter.hxx>

Inheritance diagram for chart::wrapper::LegendItemConverter:
[legend]
Collaboration diagram for chart::wrapper::LegendItemConverter:
[legend]

Public Member Functions

 LegendItemConverter (const css::uno::Reference< css::beans::XPropertySet > &rPropertySet, SfxItemPool &rItemPool, SdrModel &rDrawModel, const css::uno::Reference< css::lang::XMultiServiceFactory > &xNamedPropertyContainerFactory, const css::awt::Size *pRefSize)
 
virtual ~LegendItemConverter () override
 
virtual void FillItemSet (SfxItemSet &rOutItemSet) const override
 applies all properties that can be mapped to items into the given item set. More...
 
virtual bool ApplyItemSet (const SfxItemSet &rItemSet) override
 applies all properties that are results of a conversion from all items in rItemSet to the internal XPropertySet. More...
 
- Public Member Functions inherited from chart::wrapper::ItemConverter
 ItemConverter (css::uno::Reference< css::beans::XPropertySet > xPropertySet, SfxItemPool &rItemPool)
 Construct an item converter that uses the given property set for reading/writing converted items. More...
 
virtual ~ItemConverter () override
 
virtual void FillItemSet (SfxItemSet &rOutItemSet) const
 applies all properties that can be mapped to items into the given item set. More...
 
virtual bool ApplyItemSet (const SfxItemSet &rItemSet)
 applies all properties that are results of a conversion from all items in rItemSet to the internal XPropertySet. More...
 
SfxItemSet CreateEmptyItemSet () const
 creates an empty item set using the given pool or a common pool if empty (see GetItemPool) and allowing all items given in the ranges returned by GetWhichPairs. More...
 

Protected Member Functions

virtual const WhichRangesContainer & GetWhichPairs () const override
 implement this method to provide an array of which-ranges More...
 
virtual bool GetItemProperty (tWhichIdType nWhichId, tPropertyNameWithMemberId &rOutProperty) const override
 implement this method to return a Property object for a given which id. More...
 
virtual void FillSpecialItem (sal_uInt16 nWhichId, SfxItemSet &rOutItemSet) const override
 for items that can not be mapped directly to a property. More...
 
virtual bool ApplySpecialItem (sal_uInt16 nWhichId, const SfxItemSet &rItemSet) override
 for items that can not be mapped directly to a property. More...
 
- Protected Member Functions inherited from chart::wrapper::ItemConverter
virtual const WhichRangesContainer & GetWhichPairs () const =0
 implement this method to provide an array of which-ranges More...
 
virtual bool GetItemProperty (tWhichIdType nWhichId, tPropertyNameWithMemberId &rOutProperty) const =0
 implement this method to return a Property object for a given which id. More...
 
virtual void FillSpecialItem (sal_uInt16 nWhichId, SfxItemSet &rOutItemSet) const
 for items that can not be mapped directly to a property. More...
 
virtual bool ApplySpecialItem (sal_uInt16 nWhichId, const SfxItemSet &rItemSet)
 for items that can not be mapped directly to a property. More...
 
SfxItemPool & GetItemPool () const
 Returns the pool. More...
 
const css::uno::Reference< css::beans::XPropertySet > & GetPropertySet () const
 Returns the XPropertySet that was given in the CTOR and is used to apply items in ApplyItemSet(). More...
 
virtual void _disposing (const css::lang::EventObject &rSource) override
 
void resetPropertySet (const css::uno::Reference< css::beans::XPropertySet > &xPropSet)
 sets a new property set, that you get with GetPropertySet(). More...
 
- Protected Member Functions inherited from utl::OEventListenerAdapter
 OEventListenerAdapter ()
 
virtual ~OEventListenerAdapter ()
 
void startComponentListening (const css::uno::Reference< css::lang::XComponent > &_rxComp)
 
void stopComponentListening (const css::uno::Reference< css::lang::XComponent > &_rxComp)
 
void stopAllComponentListening ()
 
virtual void _disposing (const css::lang::EventObject &_rSource)=0
 

Private Attributes

std::vector< std::unique_ptr< ItemConverter > > m_aConverters
 

Additional Inherited Members

- Public Types inherited from chart::wrapper::ItemConverter
typedef sal_uInt16 tWhichIdType
 
typedef OUString tPropertyNameType
 
typedef sal_uInt8 tMemberIdType
 
typedef std::pair< tPropertyNameType, tMemberIdType > tPropertyNameWithMemberId
 
- Static Public Member Functions inherited from chart::wrapper::ItemConverter
static void InvalidateUnequalItems (SfxItemSet &rDestSet, const SfxItemSet &rSourceSet)
 Invalidates all items in rDestSet, that are set (state SfxItemState::SET) in both item sets (rDestSet and rSourceSet) and have differing content. More...
 

Detailed Description

Definition at line 33 of file LegendItemConverter.hxx.

Constructor & Destructor Documentation

◆ LegendItemConverter()

chart::wrapper::LegendItemConverter::LegendItemConverter ( const css::uno::Reference< css::beans::XPropertySet > &  rPropertySet,
SfxItemPool &  rItemPool,
SdrModel &  rDrawModel,
const css::uno::Reference< css::lang::XMultiServiceFactory > &  xNamedPropertyContainerFactory,
const css::awt::Size *  pRefSize 
)

Definition at line 39 of file LegendItemConverter.cxx.

References chart::wrapper::LineAndFillProperties, and m_aConverters.

◆ ~LegendItemConverter()

chart::wrapper::LegendItemConverter::~LegendItemConverter ( )
overridevirtual

Definition at line 55 of file LegendItemConverter.cxx.

Member Function Documentation

◆ ApplyItemSet()

bool chart::wrapper::LegendItemConverter::ApplyItemSet ( const SfxItemSet &  rItemSet)
overridevirtual

applies all properties that are results of a conversion from all items in rItemSet to the internal XPropertySet.

Call this method after a dialog was closed with OK

Returns
true, if any properties have been changed, false otherwise.

Reimplemented from chart::wrapper::ItemConverter.

Definition at line 68 of file LegendItemConverter.cxx.

References chart::wrapper::ItemConverter::ApplyItemSet(), and m_aConverters.

◆ ApplySpecialItem()

bool chart::wrapper::LegendItemConverter::ApplySpecialItem ( sal_uInt16  nWhichId,
const SfxItemSet &  rItemSet 
)
overrideprotectedvirtual

for items that can not be mapped directly to a property.

This method is called from ApplyItemSet(), if GetItemProperty() returns false.

The default implementation returns just false and shows an assertion

Returns
true if the item changed a property, false otherwise.
Exceptions
css::uno::Exception

Reimplemented from chart::wrapper::ItemConverter.

Definition at line 91 of file LegendItemConverter.cxx.

References DBG_UNHANDLED_EXCEPTION, SfxItemSet::GetItemIfSet(), chart::wrapper::ItemConverter::GetPropertySet(), getPropertyValue(), SCHATTR_LEGEND_NO_OVERLAY(), SCHATTR_LEGEND_POS(), and SCHATTR_LEGEND_SHOW().

◆ FillItemSet()

void chart::wrapper::LegendItemConverter::FillItemSet ( SfxItemSet &  rOutItemSet) const
overridevirtual

applies all properties that can be mapped to items into the given item set.

Call this method before opening a dialog.

Parameters
rOutItemSetthe SfxItemSet is filled with all items that are a result of a conversion from a property of the internal XPropertySet.

Reimplemented from chart::wrapper::ItemConverter.

Definition at line 59 of file LegendItemConverter.cxx.

References chart::wrapper::ItemConverter::FillItemSet(), and m_aConverters.

◆ FillSpecialItem()

void chart::wrapper::LegendItemConverter::FillSpecialItem ( sal_uInt16  nWhichId,
SfxItemSet &  rOutItemSet 
) const
overrideprotectedvirtual

for items that can not be mapped directly to a property.

This method is called from FillItemSet(), if GetItemProperty() returns false.

The default implementation does nothing except showing an assertion

Exceptions
css::uno::Exception

Reimplemented from chart::wrapper::ItemConverter.

Definition at line 174 of file LegendItemConverter.cxx.

References chart::wrapper::ItemConverter::GetPropertySet(), SfxItemSet::Put(), SCHATTR_LEGEND_NO_OVERLAY(), SCHATTR_LEGEND_POS(), and SCHATTR_LEGEND_SHOW().

◆ GetItemProperty()

bool chart::wrapper::LegendItemConverter::GetItemProperty ( tWhichIdType  nWhichId,
tPropertyNameWithMemberId &  rOutProperty 
) const
overrideprotectedvirtual

implement this method to return a Property object for a given which id.

Parameters
rOutPropertyIf true is returned, this contains the property name and the corresponding Member-Id.
Returns
true, if the item can be mapped to a property.

Implements chart::wrapper::ItemConverter.

Definition at line 85 of file LegendItemConverter.cxx.

◆ GetWhichPairs()

const WhichRangesContainer & chart::wrapper::LegendItemConverter::GetWhichPairs ( ) const
overrideprotectedvirtual

implement this method to provide an array of which-ranges

Implements chart::wrapper::ItemConverter.

Definition at line 79 of file LegendItemConverter.cxx.

References nLegendWhichPairs.

Member Data Documentation

◆ m_aConverters

std::vector< std::unique_ptr<ItemConverter> > chart::wrapper::LegendItemConverter::m_aConverters
private

Definition at line 56 of file LegendItemConverter.hxx.

Referenced by ApplyItemSet(), FillItemSet(), and LegendItemConverter().


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