diff options
| author | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-07-23 09:55:58 -0400 |
|---|---|---|
| committer | Kohei Yoshida <kohei.yoshida@collabora.com> | 2014-07-23 11:04:38 -0400 |
| commit | fc17cc850711a59dd52e93e0961a21c7ac8bd189 (patch) | |
| tree | 5e971384ea303a2fd0e4aa901741d825f4c555a7 /chart2 | |
| parent | 0b6437c9d6bb12359ed0fb1a7f507dfc3163c64d (diff) | |
Add documentation.
Change-Id: Ifb5060183866d3e8ea8ecaa715b297717d1dd370
Diffstat (limited to 'chart2')
| -rw-r--r-- | chart2/source/view/inc/PropertyMapper.hxx | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/chart2/source/view/inc/PropertyMapper.hxx b/chart2/source/view/inc/PropertyMapper.hxx index 289b97ab40b5..610f24cdf89a 100644 --- a/chart2/source/view/inc/PropertyMapper.hxx +++ b/chart2/source/view/inc/PropertyMapper.hxx @@ -43,6 +43,12 @@ typedef ::comphelper::MakeSequence< OUString > tMakeNameSequence; typedef ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > tAnySequence; typedef ::comphelper::MakeSequence< ::com::sun::star::uno::Any > tMakeAnySequence; +/** + * PropertyMapper provides easy mapping of the property names of various + * objects in the chart model, to the property names of the destination + * shape objects (those whose service names begin with + * com.sun.star.drawing.). + */ class OOO_DLLPUBLIC_CHARTTOOLS PropertyMapper { public: @@ -54,6 +60,16 @@ public: , const tPropertyNameMap& rMap , tPropertyNameValueMap* pOverwriteMap=0 ); + /** + * Fetch property values from the source object and map it to the + * destination container. Only those properties that are explicitly set + * will be inserted into the destination container. + * + * @param rValueMap destination container + * @param rNameMap property name mapping rule + * @param xSourceProp source object from which the property values are + * pulled. + */ static void getValueMap( tPropertyNameValueMap& rValueMap , const tPropertyNameMap& rNameMap |