Doxygenize some docs, translate to English while at it.

Change-Id: I977981bb45da1599e8d46bd8d961dcbb01ebd99b
This commit is contained in:
Thorsten Behrens
2013-08-01 11:01:00 +02:00
parent 3bade6b479
commit 44cd56e0ac
2 changed files with 29 additions and 21 deletions

View File

@@ -151,6 +151,31 @@ public:
virtual SfxMapUnit GetMetric( sal_uInt16 nWhich ) const;
void SetDefaultMetric( SfxMapUnit eNewMetric );
/** Request string representation of pool items
This virtual function produces a string representation, of
from the respective SfxItemPool subclass' known SfxPoolItems.
Subclasses, please overwrite this method, and handle
SfxPoolItems that don't return useful/complete information on
SfxPoolItem::GetPresentation()
This baseclass yields the unmodified string representation of
rItem.
@param[in] rItem
SfxPoolItem to query the string representation of
@param[in] ePresent
requested kind of representation - see SfxItemPresentation
@param[in] eMetric
requested unit of measure of the representation
@param[out] rText
string representation of 'rItem'
*/
virtual SfxItemPresentation GetPresentation( const SfxPoolItem& rItem,
SfxItemPresentation ePresentation,
SfxMapUnit ePresentationMetric,

View File

@@ -462,29 +462,12 @@ const OUString& SfxItemPool::GetName() const
SfxItemPresentation SfxItemPool::GetPresentation
(
const SfxPoolItem& rItem, /* IN: <SfxPoolItem>, dessen textuelle
Wert-Darstellung geliefert werden
soll */
SfxItemPresentation ePresent, /* IN: gew"unschte Art der Darstellung;
siehe <SfxItemPresentation> */
SfxMapUnit eMetric, /* IN: gew"unschte Ma\seinheit der Darstellung */
OUString& rText, /* OUT: textuelle Darstellung von 'rItem' */
const SfxPoolItem& rItem,
SfxItemPresentation ePresent,
SfxMapUnit eMetric,
OUString& rText,
const IntlWrapper * pIntlWrapper
) const
/* [Beschreibung]
"Uber diese virtuelle Methode k"onnen textuelle Darstellungen der
von der jeweilige SfxItemPool-Subklasse verwalteten SfxPoolItems
angefordert werden.
In Ableitungen sollte diese Methode "uberladen werden und auf
SfxPoolItems reagiert werden, die bei <SfxPoolItem::GetPresentation()const>
keine vollst"andige Information liefern k"onnen.
Die Basisklasse liefert die unver"anderte Presentation von 'rItem'.
*/
{
DBG_CHKTHIS(SfxItemPool, 0);
return rItem.GetPresentation(