[Libreoffice-commits] .: sw/inc
Libreoffice Gerrit user
logerrit at kemper.freedesktop.org
Sun Sep 2 01:01:29 PDT 2012
sw/inc/docary.hxx | 32 +--
sw/inc/docfac.hxx | 2
sw/inc/docsh.hxx | 96 +++++-----
sw/inc/docstyle.hxx | 24 +-
sw/inc/docufld.hxx | 70 +++----
sw/inc/drawdoc.hxx | 4
sw/inc/edglbldc.hxx | 4
sw/inc/editsh.hxx | 398 +++++++++++++++++++++----------------------
sw/inc/expfld.hxx | 52 ++---
sw/inc/fchrfmt.hxx | 10 -
sw/inc/fesh.hxx | 329 +++++++++++++++++------------------
sw/inc/fldbas.hxx | 102 +++++------
sw/inc/flyenum.hxx | 14 -
sw/inc/flypos.hxx | 10 -
sw/inc/fmtanchr.hxx | 14 -
sw/inc/fmtautofmt.hxx | 8
sw/inc/fmtclbl.hxx | 2
sw/inc/fmtclds.hxx | 76 ++++----
sw/inc/fmtcnct.hxx | 8
sw/inc/fmtcntnt.hxx | 6
sw/inc/fmtcol.hxx | 26 +-
sw/inc/fmteiro.hxx | 2
sw/inc/fmtflcnt.hxx | 8
sw/inc/fmtfld.hxx | 12 -
sw/inc/fmtfollowtextflow.hxx | 2
sw/inc/fmtfordr.hxx | 2
sw/inc/fmtfsize.hxx | 10 -
sw/inc/fmtftn.hxx | 14 -
sw/inc/fmtftntx.hxx | 8
sw/inc/fmthdft.hxx | 14 -
sw/inc/fmtinfmt.hxx | 16 -
sw/inc/fmtline.hxx | 6
sw/inc/fmtlsplt.hxx | 2
sw/inc/fmtmeta.hxx | 20 +-
sw/inc/fmtornt.hxx | 10 -
sw/inc/fmtpdsc.hxx | 20 +-
36 files changed, 716 insertions(+), 717 deletions(-)
New commits:
commit fc971580c76db8b7c9053883fef029fe1a243e21
Author: Abdulmajeed Al-Abaulrazzaq <aalabdulrazzaq at kacst.edu.sa>
Date: Sun Sep 2 09:05:03 2012 +0300
Modifying comments to meet doxygen standards
Change-Id: I4c82b7e543ec74cec3d4eb2985a3e4ec68c16b11
Change-Id: Iaf83b7119767cf0b953cab62d5555141e8e154bb
Reviewed-on: https://gerrit.libreoffice.org/496
Reviewed-by: Norbert Thiebaud <nthiebaud at gmail.com>
Tested-by: Norbert Thiebaud <nthiebaud at gmail.com>
diff --git a/sw/inc/docary.hxx b/sw/inc/docary.hxx
index 4f9b9af..0948332 100644
--- a/sw/inc/docary.hxx
+++ b/sw/inc/docary.hxx
@@ -49,13 +49,13 @@ class SwTxtFmtColl;
class SwGrfFmtColl;
namespace com { namespace sun { namespace star { namespace i18n {
- struct ForbiddenCharacters; // comes from the I18N UNO interface
+ struct ForbiddenCharacters; ///< comes from the I18N UNO interface
}}}}
#include <swtypes.hxx>
-// provides some methods for generic operations on lists that contain
-// SwFmt* subclasses.
+/** provides some methods for generic operations on lists that contain
+SwFmt* subclasses. */
class SwFmtsBase
{
public:
@@ -70,11 +70,11 @@ public:
virtual size_t GetFmtCount() const { return size(); }
virtual SwFmt* GetFmt(size_t idx) const { return (SwFmt*)operator[](idx); }
sal_uInt16 GetPos(const SwGrfFmtColl* pFmt) const;
- // free's any remaining child objects
+ /// free's any remaining child objects
virtual ~SwGrfFmtColls() {}
};
-// Specific frame formats (frames, DrawObjects).
+/// Specific frame formats (frames, DrawObjects).
class SW_DLLPUBLIC SwFrmFmts : public std::vector<SwFrmFmt*>, public SwFmtsBase
{
public:
@@ -82,7 +82,7 @@ public:
virtual SwFmt* GetFmt(size_t idx) const { return (SwFmt*)operator[](idx); }
sal_uInt16 GetPos(const SwFrmFmt* pFmt) const;
bool Contains(const SwFrmFmt* pFmt) const;
- // free's any remaining child objects
+ /// free's any remaining child objects
virtual ~SwFrmFmts();
};
@@ -93,7 +93,7 @@ public:
virtual SwFmt* GetFmt(size_t idx) const { return (SwFmt*)operator[](idx); }
sal_uInt16 GetPos(const SwCharFmt* pFmt) const;
bool Contains(const SwCharFmt* pFmt) const;
- // free's any remaining child objects
+ /// free's any remaining child objects
virtual ~SwCharFmts();
};
@@ -106,7 +106,7 @@ public:
virtual ~SwTxtFmtColls() {}
};
-// Array of Undo-history.
+/// Array of Undo-history.
class SW_DLLPUBLIC SwSectionFmts : public std::vector<SwSectionFmt*>, public SwFmtsBase
{
public:
@@ -114,27 +114,27 @@ public:
virtual SwFmt* GetFmt(size_t idx) const { return (SwFmt*)operator[](idx); }
sal_uInt16 GetPos(const SwSectionFmt* pFmt) const;
bool Contains(const SwSectionFmt* pFmt) const;
- // free's any remaining child objects
+ /// free's any remaining child objects
virtual ~SwSectionFmts();
};
class SwFldTypes : public std::vector<SwFieldType*> {
public:
- // the destructor will free all objects still in the vector
+ /// the destructor will free all objects still in the vector
~SwFldTypes();
sal_uInt16 GetPos(const SwFieldType* pFieldType) const;
};
class SwTOXTypes : public std::vector<SwTOXType*> {
public:
- // the destructor will free all objects still in the vector
+ /// the destructor will free all objects still in the vector
~SwTOXTypes();
sal_uInt16 GetPos(const SwTOXType* pTOXType) const;
};
class SW_DLLPUBLIC SwNumRuleTbl : public std::vector<SwNumRule*> {
public:
- // the destructor will free all objects still in the vector
+ /// the destructor will free all objects still in the vector
~SwNumRuleTbl();
sal_uInt16 GetPos(const SwNumRule* pRule) const;
};
@@ -166,9 +166,9 @@ public:
void DeleteAndDestroy( sal_uInt16 nPos, sal_uInt16 nLen = 1 );
void DeleteAndDestroyAll();
- // Search next or previous Redline with the same Seq. No.
- // Search can be restricted via Lookahaed.
- // Using 0 or USHRT_MAX makes search the whole array.
+ /** Search next or previous Redline with the same Seq. No.
+ Search can be restricted via Lookahaed.
+ Using 0 or USHRT_MAX makes search the whole array. */
sal_uInt16 FindNextOfSeqNo( sal_uInt16 nSttPos, sal_uInt16 nLookahead = 20 ) const;
sal_uInt16 FindPrevOfSeqNo( sal_uInt16 nSttPos, sal_uInt16 nLookahead = 20 ) const;
sal_uInt16 FindNextSeqNo( sal_uInt16 nSeqNo, sal_uInt16 nSttPos,
@@ -183,7 +183,7 @@ public:
class SwUnoCrsrTbl : public std::set<SwUnoCrsr*> {
public:
- // the destructor will free all objects still in the set
+ /// the destructor will free all objects still in the set
~SwUnoCrsrTbl();
};
diff --git a/sw/inc/docfac.hxx b/sw/inc/docfac.hxx
index 12025fd..5b5254b 100644
--- a/sw/inc/docfac.hxx
+++ b/sw/inc/docfac.hxx
@@ -41,7 +41,7 @@ public:
SwDocFac( SwDoc *pDoc = 0 );
~SwDocFac();
- // Document is created after calling Read(...).
+ /// Document is created after calling Read(...).
SwDoc* GetDoc();
};
diff --git a/sw/inc/docsh.hxx b/sw/inc/docsh.hxx
index 96a1eaa..7355b54 100644
--- a/sw/inc/docsh.hxx
+++ b/sw/inc/docsh.hxx
@@ -64,34 +64,34 @@ class IDocumentChartDataProviderAccess;
class SW_DLLPUBLIC SwDocShell: public SfxObjectShell, public SfxListener
{
- SwDoc* pDoc; // Document.
- rtl::Reference< SfxStyleSheetBasePool > mxBasePool; // Passing through for formats.
- FontList* pFontList; // Current Fontlist.
+ SwDoc* pDoc; ///< Document.
+ rtl::Reference< SfxStyleSheetBasePool > mxBasePool; ///< Passing through for formats.
+ FontList* pFontList; ///< Current Fontlist.
- // For "historical reasons" nothing can be done without the WrtShell.
- // Back-pointer on View (again "for historical reasons").
- // Back-pointer is valid until in Activate a new one is set
- // or until it is deleted in the View's Dtor.
+ /** For "historical reasons" nothing can be done without the WrtShell.
+ Back-pointer on View (again "for historical reasons").
+ Back-pointer is valid until in Activate a new one is set
+ or until it is deleted in the View's Dtor. */
SwView* pView;
SwWrtShell* pWrtShell;
- Timer aFinishedTimer; // Timer for checking graphics-links.
- // If all are present, the doc is loaded completely.
+ Timer aFinishedTimer; /**< Timer for checking graphics-links.
+ If all are present, the doc is loaded completely. */
comphelper::EmbeddedObjectContainer* pOLEChildList;
- sal_Int16 nUpdateDocMode; // contains the com::sun::star::document::UpdateDocMode
- bool bInUpdateFontList; //prevent nested calls of UpdateFontList
- bool bIsATemplate; //prevent nested calls of UpdateFontList
+ sal_Int16 nUpdateDocMode; ///< contains the com::sun::star::document::UpdateDocMode
+ bool bInUpdateFontList; ///< prevent nested calls of UpdateFontList
+ bool bIsATemplate; ///< prevent nested calls of UpdateFontList
- // Methods for access to doc.
+ /// Methods for access to doc.
SW_DLLPRIVATE void AddLink();
SW_DLLPRIVATE void RemoveLink();
- // Catch hint for DocInfo.
+ /// Catch hint for DocInfo.
SW_DLLPRIVATE virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
- // FileIO
+ /// FileIO
SW_DLLPRIVATE virtual sal_Bool InitNew( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& xStorage );
SW_DLLPRIVATE virtual sal_Bool Load( SfxMedium& rMedium );
SW_DLLPRIVATE virtual sal_Bool LoadFrom( SfxMedium& rMedium );
@@ -103,13 +103,13 @@ class SW_DLLPUBLIC SwDocShell: public SfxObjectShell, public SfxListener
SW_DLLPRIVATE virtual sal_uInt16 PrepareClose( sal_Bool bUI = sal_True, sal_Bool bForBrowsing = sal_False );
- // Make DocInfo known to the Doc.
+ /// Make DocInfo known to the Doc.
SW_DLLPRIVATE virtual SfxDocumentInfoDialog* CreateDocumentInfoDialog(
Window *pParent, const SfxItemSet &);
- // OLE-stuff
+ /// OLE-stuff
SW_DLLPRIVATE virtual void Draw( OutputDevice*, const JobSetup&, sal_uInt16);
- // Methods for StyleSheets
+ /// Methods for StyleSheets
SW_DLLPRIVATE sal_uInt16 Edit( const String &rName, const String& rParent, sal_uInt16 nFamily,
sal_uInt16 nMask, sal_Bool bNew,
sal_uInt16 nPageId = 0,
@@ -124,7 +124,7 @@ class SW_DLLPUBLIC SwDocShell: public SfxObjectShell, public SfxListener
sal_uInt16 nFamily, sal_uInt16 nMask, SwWrtShell* pShell = 0);
SW_DLLPRIVATE void InitDraw();
- SW_DLLPRIVATE void SubInitNew(); // for InitNew and HtmlSourceMode.
+ SW_DLLPRIVATE void SubInitNew(); ///< for InitNew and HtmlSourceMode.
SW_DLLPRIVATE void RemoveOLEObjects();
SW_DLLPRIVATE void CalcLayoutForOLEObjects();
@@ -143,7 +143,7 @@ protected:
public:
using SotObject::GetInterface;
- // but we implement this ourselves.
+ /// but we implement this ourselves.
SFX_DECL_INTERFACE(SW_DOCSHELL)
SFX_DECL_OBJECTFACTORY()
TYPEINFO();
@@ -152,16 +152,16 @@ public:
static rtl::OUString GetEventName( sal_Int32 nId );
- //Doc is required for SO data exchange!
+ /// Doc is required for SO data exchange!
SwDocShell( SfxObjectCreateMode eMode = SFX_CREATE_MODE_EMBEDDED );
SwDocShell( const sal_uInt64 i_nSfxCreationFlags );
SwDocShell( SwDoc *pDoc, SfxObjectCreateMode eMode = SFX_CREATE_MODE_STANDARD );
~SwDocShell();
- // OLE 2.0-notification.
+ /// OLE 2.0-notification.
DECL_LINK( Ole2ModifiedHdl, void * );
- // OLE-stuff.
+ /// OLE-stuff.
virtual void SetVisArea( const Rectangle &rRect );
virtual Rectangle GetVisArea( sal_uInt16 nAspect ) const;
virtual Printer *GetDocumentPrinter();
@@ -172,7 +172,7 @@ public:
virtual void PrepareReload();
virtual void SetModified( sal_Bool = sal_True );
- // Dispatcher
+ /// Dispatcher
void Execute(SfxRequest &);
void ExecStyleSheet(SfxRequest&);
void ExecDB(SfxRequest&);
@@ -181,7 +181,7 @@ public:
void StateAlways(SfxItemSet &);
void StateStyleSheet(SfxItemSet&, SwWrtShell* pSh = 0 );
- // returns Doc. But be careful!
+ /// returns Doc. But be careful!
inline SwDoc* GetDoc() { return pDoc; }
inline const SwDoc* GetDoc() const { return pDoc; }
IDocumentDeviceAccess* getIDocumentDeviceAccess();
@@ -192,13 +192,13 @@ public:
void UpdateFontList();
void UpdateChildWindows();
- // global IO.
+ /// global IO.
virtual sal_Bool Save();
- // For Style PI.
+ /// For Style PI.
virtual SfxStyleSheetBasePool* GetStyleSheetPool();
- // For Organizer.
+ /// For Organizer.
virtual sal_Bool Insert(SfxObjectShell &rSource,
sal_uInt16 nSourceIdx1,
sal_uInt16 nSourceIdx2,
@@ -214,22 +214,22 @@ public:
virtual Bitmap GetStyleFamilyBitmap( SfxStyleFamily eFamily );
- // Set View for actions via Shell.
+ /// Set View for actions via Shell.
void SetView(SwView* pVw);
const SwView *GetView() const { return pView; }
SwView *GetView() { return pView; }
- // Accress to the SwWrtShell belonging to SwView.
+ /// Accress to the SwWrtShell belonging to SwView.
SwWrtShell *GetWrtShell() { return pWrtShell; }
const SwWrtShell *GetWrtShell() const { return pWrtShell; }
- // For Core - it knows the DocShell but not the WrtShell!
+ /// For Core - it knows the DocShell but not the WrtShell!
SwFEShell *GetFEShell();
const SwFEShell *GetFEShell() const
{ return ((SwDocShell*)this)->GetFEShell(); }
- // For inserting document.
+ /// For inserting document.
Reader* StartConvertFrom(SfxMedium& rMedium, SwReader** ppRdr,
SwCrsrShell* pCrsrSh = 0, SwPaM* pPaM = 0);
@@ -252,29 +252,29 @@ public:
void _LoadStyles( SfxObjectShell& rSource, sal_Bool bPreserveCurrentDocument );
- // Display dialog for page style. If required display column page.
+ /// Display dialog for page style. If required display column page.
void FormatPage( const String& rPage,
sal_uInt16 nPageId = 0,
SwWrtShell* pActShell = 0 );
// #i59688#
- // linked graphics are now loaded on demand.
- // Thus, loading of linked graphics no longer needed and necessary for
- // the load of document being finished.
+ /** linked graphics are now loaded on demand.
+ Thus, loading of linked graphics no longer needed and necessary for
+ the load of document being finished. */
void LoadingFinished();
- // Cancel transfer (called from SFX).
+ /// Cancel transfer (called from SFX).
virtual void CancelTransfers();
- // Re-read Doc from Html-source.
+ /// Re-read Doc from Html-source.
void ReloadFromHtml( const String& rStreamName, SwSrcView* pSrcView );
sal_Int16 GetUpdateDocMode() const {return nUpdateDocMode;}
- //Activate wait cursor for all windows of this document
- //Optionally all dispatcher could be Locked
- //Usually locking should be done using the class: SwWaitObject!
+ /** Activate wait cursor for all windows of this document
+ Optionally all dispatcher could be Locked
+ Usually locking should be done using the class: SwWaitObject! */
void EnterWait( sal_Bool bLockDispatcher );
void LeaveWait( sal_Bool bLockDispatcher );
@@ -287,13 +287,13 @@ public:
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > GetEventNames();
- // #i20883# Digital Signatures and Encryption
+ /// #i20883# Digital Signatures and Encryption
virtual sal_uInt16 GetHiddenInformationState( sal_uInt16 nStates );
- // #i42634# Overwrites SfxObjectShell::UpdateLinks
- // This new function is necessary to trigger update of links in docs
- // read by the binary filter:
+ /** #i42634# Overwrites SfxObjectShell::UpdateLinks
+ This new function is necessary to trigger update of links in docs
+ read by the binary filter: */
virtual void UpdateLinks();
::com::sun::star::uno::Reference< ::com::sun::star::frame::XController >
@@ -305,8 +305,8 @@ public:
virtual const ::sfx2::IXmlIdRegistry* GetXmlIdRegistry() const;
- // passwword protection for Writer (derived from SfxObjectShell)
- // see also: FN_REDLINE_ON, FN_REDLINE_ON
+ /** passwword protection for Writer (derived from SfxObjectShell)
+ see also: FN_REDLINE_ON, FN_REDLINE_ON */
virtual bool IsChangeRecording() const;
virtual bool HasChangeRecordProtection() const;
virtual void SetChangeRecording( bool bActivate );
@@ -315,7 +315,7 @@ public:
};
class Graphic;
-//implemented in source/ui/docvw/romenu.cxx
+ /// implemented in source/ui/docvw/romenu.cxx
String ExportGraphic( const Graphic &rGraphic, const String &rGrfName );
#endif
diff --git a/sw/inc/docstyle.hxx b/sw/inc/docstyle.hxx
index 6023143..576e5d2 100644
--- a/sw/inc/docstyle.hxx
+++ b/sw/inc/docstyle.hxx
@@ -74,10 +74,10 @@ class SW_DLLPUBLIC SwDocStyleSheet : public SfxStyleSheetBase
sal_Bool bPhysical;
- // Make empty shell a real StyleSheet (Core).
+ /// Make empty shell a real StyleSheet (Core).
SW_DLLPRIVATE void Create();
- // Fill StyleSheet with data.
+ /// Fill StyleSheet with data.
enum FillStyleType {
FillOnlyName,
FillAllInfo,
@@ -106,16 +106,16 @@ public:
sal_Bool IsPhysical() const { return bPhysical; }
void SetPhysical(sal_Bool bPhys);
- // add optional parameter <bResetIndentAttrsAtParagraphStyle>, default value sal_False,
- // which indicates that the indent attributes at a paragraph style should
- // be reset in case that a list style is applied to the paragraph style and
- // no indent attributes are applied.
+ /** add optional parameter <bResetIndentAttrsAtParagraphStyle>, default value sal_False,
+ which indicates that the indent attributes at a paragraph style should
+ be reset in case that a list style is applied to the paragraph style and
+ no indent attributes are applied. */
void SetItemSet( const SfxItemSet& rSet,
const bool bResetIndentAttrsAtParagraphStyle = false );
virtual SfxItemSet& GetItemSet();
- // new method for paragraph styles to merge indent attributes of applied list
- // style into the given item set, if the list style indent attributes are applicable.
+ /** new method for paragraph styles to merge indent attributes of applied list
+ style into the given item set, if the list style indent attributes are applicable. */
void MergeIndentAttrsOfListStyle( SfxItemSet& rSet );
virtual const String& GetParent() const;
virtual const String& GetFollow() const;
@@ -123,8 +123,8 @@ public:
virtual sal_uLong GetHelpId( String& rFile );
virtual void SetHelpId( const String& r, sal_uLong nId );
- // Preset the members without physical access.
- // Used by StyleSheetPool.
+ /** Preset the members without physical access.
+ Used by StyleSheetPool. */
void PresetName(const String& rName) { aName = rName; }
void PresetNameAndFamily(const String& rName);
void PresetParent(const String& rName){ aParent = rName; }
@@ -186,7 +186,7 @@ class SwDocStyleSheetPool : public SfxStyleSheetBasePool
{
rtl::Reference< SwDocStyleSheet > mxStyleSheet;
SwDoc& rDoc;
- sal_Bool bOrganizer : 1; // Organizer
+ sal_Bool bOrganizer : 1; ///< Organizer
virtual SfxStyleSheetBase* Create( const String&, SfxStyleFamily, sal_uInt16 nMask);
@@ -225,7 +225,7 @@ public:
protected:
virtual ~SwDocStyleSheetPool();
- //For not-so-clever compilers.
+ /// For not-so-clever compilers.
private:
SwDocStyleSheetPool( const SwDocStyleSheetPool& );
};
diff --git a/sw/inc/docufld.hxx b/sw/inc/docufld.hxx
index b62b2f6..0f6158b 100644
--- a/sw/inc/docufld.hxx
+++ b/sw/inc/docufld.hxx
@@ -73,10 +73,10 @@ enum SwDocStatSubType
typedef sal_uInt16 SwDocInfoSubType;
namespace nsSwDocInfoSubType
{
- // NB: these must denote consecutive integers!
- // NB2: these are extended by 4 DI_INFO values for backward compatibility
- // in filter/html/htmlfld.cxx, so make sure that DI_SUBTYPE_END
- // really is the end, and is at least 4 less than DI_SUB_*!
+ /** NB: these must denote consecutive integers!
+ NB2: these are extended by 4 DI_INFO values for backward compatibility
+ in filter/html/htmlfld.cxx, so make sure that DI_SUBTYPE_END
+ really is the end, and is at least 4 less than DI_SUB_*! */
const SwDocInfoSubType DI_SUBTYPE_BEGIN = 0;
const SwDocInfoSubType DI_TITEL = DI_SUBTYPE_BEGIN;
const SwDocInfoSubType DI_THEMA = 1;
@@ -99,7 +99,7 @@ namespace nsSwDocInfoSubType
}
-enum RegInfoFormat // Only for loading of old documents!!!
+enum RegInfoFormat ///< Only for loading of old documents!!!
{
RF_AUTHOR,
RF_TIME,
@@ -297,7 +297,7 @@ public:
class SwDocStatFieldType : public SwFieldType
{
SwDoc* pDoc;
- sal_Int16 nNumberingType;//com::sun::star::style::NumberingType
+ sal_Int16 nNumberingType; ///< com::sun::star::style::NumberingType
public:
SwDocStatFieldType(SwDoc*);
@@ -352,16 +352,16 @@ public:
class SwHiddenTxtField : public SwField
{
- rtl::OUString aTRUETxt; // Text if condition sal_True.
- rtl::OUString aFALSETxt; // If condition false.
- rtl::OUString aContent; // Evaluated DB-text.
+ rtl::OUString aTRUETxt; ///< Text if condition sal_True.
+ rtl::OUString aFALSETxt; ///< If condition false.
+ rtl::OUString aContent; ///< Evaluated DB-text.
- rtl::OUString aCond; // Condition.
+ rtl::OUString aCond; ///< Condition.
sal_uInt16 nSubType;
- sal_Bool bCanToggle : 1; // Can field be toggled alone?
- sal_Bool bIsHidden : 1; // Is it not visible?
- sal_Bool bValid : 1; // Is DB-field evaluated?
+ sal_Bool bCanToggle : 1; ///< Can field be toggled alone?
+ sal_Bool bIsHidden : 1; ///< Is it not visible?
+ sal_Bool bValid : 1; ///< Is DB-field evaluated?
virtual String Expand() const;
virtual SwField* Copy() const;
@@ -388,11 +388,11 @@ public:
String GetColumnName(const String& rName);
String GetDBName(const String& rName, SwDoc *pDoc);
- // Condition
+ /// Condition
virtual void SetPar1(const rtl::OUString& rStr);
virtual const rtl::OUString& GetPar1() const;
- // True/False - String
+ /// True/False - String
virtual void SetPar2(const rtl::OUString& rStr);
virtual rtl::OUString GetPar2() const;
@@ -424,7 +424,7 @@ class SwHiddenParaField : public SwField
rtl::OUString aCond;
sal_Bool bIsHidden:1;
public:
- // Direct input, delete old value.
+ /// Direct input, delete old value.
SwHiddenParaField(SwHiddenParaFieldType*, const String& rCond);
virtual String Expand() const;
@@ -433,7 +433,7 @@ public:
void SetHidden(sal_Bool bHidden) { bIsHidden = bHidden; }
sal_Bool IsHidden() const { return bIsHidden; }
- //Query, set condition.
+ /// Query, set condition.
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt16 nWhich ) const;
@@ -468,7 +468,7 @@ class SW_DLLPUBLIC SwMacroField : public SwField
virtual SwField* Copy() const;
public:
- // Direct input, delete old value.
+ /// Direct input, delete old value.
SwMacroField( SwMacroFieldType*, const String& rLibAndName,
const String& rTxt);
@@ -479,11 +479,11 @@ public:
virtual String GetFieldName() const;
- // Library and FileName
+ /// Library and FileName
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
- // Macrotext
+ /// Macrotext
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt16 nWhich ) const;
@@ -521,7 +521,7 @@ class SW_DLLPUBLIC SwPostItField : public SwField
rtl::OUString sTxt;
rtl::OUString sAuthor;
rtl::OUString sInitials; ///< Initials of the author.
- rtl::OUString sName; ///< Name of the comment.
+ rtl::OUString sName; ///< Name of the comment.
DateTime aDateTime;
OutlinerParaObject* mpText;
SwTextAPIObject* m_pTextObject;
@@ -538,11 +538,11 @@ public:
inline const Date GetDate() const { return aDateTime.GetDate(); }
inline const Time GetTime() const { return aDateTime.GetTime(); }
- // Author
+ /// Author
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
- // Text
+ /// Text
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
const rtl::OUString& GetTxt() const { return sTxt; }
@@ -647,7 +647,7 @@ public:
virtual SwFieldType* Copy() const;
protected:
- // Overlay, because there is nothing to update!
+ /// Overlay, because there is nothing to update!
virtual void Modify( const SfxPoolItem*, const SfxPoolItem * );
};
@@ -689,7 +689,7 @@ class SwRefPageGetFieldType : public SwFieldType
void UpdateField( SwTxtFld* pTxtFld, _SetGetExpFlds& rSetList );
protected:
- // overwritten to update all RefPageGet fields
+ /// overwritten to update all RefPageGet fields
virtual void Modify( const SfxPoolItem*, const SfxPoolItem * );
public:
SwRefPageGetFieldType( SwDoc* pDoc );
@@ -744,11 +744,11 @@ public:
virtual String Expand() const;
virtual SwField* Copy() const;
- // Placeholder-Text
+ /// Placeholder-Text
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
- // Hint-Text
+ /// Hint-Text
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
@@ -777,11 +777,11 @@ public:
class SwScriptField : public SwField
{
- rtl::OUString sType; // Type of Code (Java/VBScript/...)
- rtl::OUString sCode; // Code as text.
- // Code as JavaCode ?
+ rtl::OUString sType; ///< Type of Code (Java/VBScript/...)
+ rtl::OUString sCode; /**< Code as text.
+ Code as JavaCode ? */
- sal_Bool bCodeURL;// Code contains URL of a script.
+ sal_Bool bCodeURL; ///< Code contains URL of a script.
public:
SwScriptField( SwScriptFieldType*, const String& rType,
@@ -792,10 +792,10 @@ public:
virtual String Expand() const;
virtual SwField* Copy() const;
- // Type
+ /// Type
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
- // Text
+ /// Text
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
@@ -825,7 +825,7 @@ public:
class SW_DLLPUBLIC SwCombinedCharField : public SwField
{
- rtl::OUString sCharacters; // combine these characters
+ rtl::OUString sCharacters; ///< combine these characters
public:
SwCombinedCharField( SwCombinedCharFieldType*, const String& rChars );
@@ -833,7 +833,7 @@ public:
virtual String Expand() const;
virtual SwField* Copy() const;
- // Characters
+ /// Characters
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
diff --git a/sw/inc/drawdoc.hxx b/sw/inc/drawdoc.hxx
index cdc2c3b..235c0bf 100644
--- a/sw/inc/drawdoc.hxx
+++ b/sw/inc/drawdoc.hxx
@@ -50,11 +50,11 @@ public:
virtual ::com::sun::star::uno::Reference<
::com::sun::star::embed::XStorage> GetDocumentStorage() const;
- // For saving of rectangles as control-replacement for versions < 5.0.
+ /// For saving of rectangles as control-replacement for versions < 5.0.
virtual SdrLayerID GetControlExportLayerId( const SdrObject & ) const;
protected:
- // overload of <SdrModel::createUnoModel()> is needed to provide corresponding uno model.
+ /// overload of <SdrModel::createUnoModel()> is needed to provide corresponding uno model.
virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createUnoModel();
};
diff --git a/sw/inc/edglbldc.hxx b/sw/inc/edglbldc.hxx
index 466b3b3..d6a2936 100644
--- a/sw/inc/edglbldc.hxx
+++ b/sw/inc/edglbldc.hxx
@@ -54,7 +54,7 @@ public:
SwGlblDocContent( const SwTOXBaseSection* pTOX );
SwGlblDocContent( const SwSection* pSect );
- // Query contents.
+ /// Query contents.
GlobalDocContentType GetType() const { return eType; }
const SwSection* GetSection() const
{ return GLBLDOC_SECTION == eType ? PTR.pSect : 0; }
@@ -62,7 +62,7 @@ public:
{ return GLBLDOC_TOXBASE == eType ? PTR.pTOX : 0; }
sal_uLong GetDocPos() const { return nDocPos; }
- // For sorting.
+ /// For sorting.
inline int operator==( const SwGlblDocContent& rCmp ) const
{ return GetDocPos() == rCmp.GetDocPos(); }
inline int operator<( const SwGlblDocContent& rCmp ) const
diff --git a/sw/inc/editsh.hxx b/sw/inc/editsh.hxx
index 44486c4..0122900 100644
--- a/sw/inc/editsh.hxx
+++ b/sw/inc/editsh.hxx
@@ -75,15 +75,15 @@ class SwTxtFmtColl;
class SwGrfNode;
class SwFlyFrmFmt;
-class SwFrmFmt; // For GetTxtNodeFmts().
+class SwFrmFmt; ///< For GetTxtNodeFmts().
class SwCharFmt;
class SwExtTextInput;
-class SwRootFrm; // For CTOR.
+class SwRootFrm; ///< For CTOR.
class Graphic;
class GraphicObject;
-class SwFmtINetFmt; // InsertURL.
+class SwFmtINetFmt; ///< InsertURL.
class SwTable;
-class SwTextBlocks; // For GlossaryRW.
+class SwTextBlocks; ///< For GlossaryRW.
class SwFmtFtn;
class SwSection;
class SwSectionData;
@@ -129,7 +129,7 @@ namespace sw {
#define GETSELTXT_PARABRK_TO_ONLYCR 2
-// For querying the INet-attributes for Navigator.
+ /// For querying the INet-attributes for Navigator.
struct SwGetINetAttr
{
String sText;
@@ -155,17 +155,17 @@ class SW_DLLPUBLIC SwEditShell: public SwCrsrShell
{
static SvxSwAutoFmtFlags* pAutoFmtFlags;
- // For the private methods DelRange and those of AutoCorrect.
+ /// For the private methods DelRange and those of AutoCorrect.
friend class SwAutoFormat;
friend void _InitCore();
friend void _FinitCore();
- // For the PamCorrAbs/-Rel methods.
+ /// For the PamCorrAbs/-Rel methods.
friend class SwUndo;
SW_DLLPRIVATE SfxPoolItem& _GetChrFmt( SfxPoolItem& ) const;
- // Returns pointer to a SwGrfNode
- // that will be used by GetGraphic() and GetGraphicSize().
+ /** Returns pointer to a SwGrfNode
+ that will be used by GetGraphic() and GetGraphicSize(). */
SW_DLLPRIVATE SwGrfNode *_GetGrfNode() const ;
SW_DLLPRIVATE void DeleteSel( SwPaM& rPam, sal_Bool* pUndo = 0 );
@@ -176,75 +176,75 @@ class SW_DLLPUBLIC SwEditShell: public SwCrsrShell
using SwModify::GetInfo;
public:
- // Edit (all selected ranges).
+ /// Edit (all selected ranges).
void Insert( sal_Unicode, sal_Bool bOnlyCurrCrsr = sal_False );
void Insert2( const String &, const bool bForceExpandHints = false );
void Overwrite( const String & );
- // Replace a selected range in a TextNode by given string.
- // Meant for Search & Replace.
- // bRegExpRplc - replace tabs (\\t) and insert found string (not \&).
- // E.g.: Fnd: "zzz", Repl: "xx\t\\t..&..\&"
- // --> "xx\t<Tab>..zzz..&"
+ /** Replace a selected range in a TextNode by given string.
+ Meant for Search & Replace.
+ bRegExpRplc - replace tabs (\\t) and insert found string (not \&).
+ E.g.: Fnd: "zzz", Repl: "xx\t\\t..&..\&"
+ --> "xx\t<Tab>..zzz..&" */
sal_Bool Replace( const String& rNewStr, sal_Bool bRegExpRplc = sal_False );
- // Delete content of all ranges.
- // If whole nodes are selected, these nodes get deleted.
+ /** Delete content of all ranges.
+ If whole nodes are selected, these nodes get deleted. */
long Delete();
- // Remove a complete paragraph.
+ /// Remove a complete paragraph.
sal_Bool DelFullPara();
- // Change text to Upper/Lower/Hiragana/Katagana/...
+ /// Change text to Upper/Lower/Hiragana/Katagana/...
void TransliterateText( sal_uInt32 nType );
- // Count words in current selection.
+ /// Count words in current selection.
void CountWords( SwDocStat& rStat ) const;
- // Delete non-visible content in the document.
- // E.g. hidden ranges, hidden paragraphs.
+ /** Delete non-visible content in the document.
+ E.g. hidden ranges, hidden paragraphs. */
sal_Bool RemoveInvisibleContent();
- // Replace fields by text - mailmerge support.
+ /// Replace fields by text - mailmerge support.
sal_Bool ConvertFieldsToText();
- // Set all numbering start points to a fixed value - mailmerge support.
+ /// Set all numbering start points to a fixed value - mailmerge support.
void SetNumberingRestart();
- // Embedds all local links (ranges/graphics).
+ /// Embedds all local links (ranges/graphics).
sal_uInt16 GetLinkUpdMode(sal_Bool bDocSettings = sal_False) const;
void SetLinkUpdMode( sal_uInt16 nMode );
- // Copy content of all ranges at current position of cursor to given Shell.
+ /// Copy content of all ranges at current position of cursor to given Shell.
long Copy( SwEditShell* pDestShell = 0 );
- // For copying via ClipBoard:
- // If table is copied into table, move all cursors away from it.
- // Copy and Paste must be in FEShell because of FlyFrames!
- // Copy all selections and the document.
+ /** For copying via ClipBoard:
+ If table is copied into table, move all cursors away from it.
+ Copy and Paste must be in FEShell because of FlyFrames!
+ Copy all selections and the document. */
sal_Bool _CopySelToDoc( SwDoc* pInsDoc, SwNodeIndex* pNdInsPos = 0 );
long SplitNode( sal_Bool bAutoFormat = sal_False, sal_Bool bCheckTableStart = sal_True );
sal_Bool AppendTxtNode();
void AutoFmtBySplitNode();
- // If cursor is in a INetAttribute it will be deleted completely
- // including the descriptive text (needed at drag & drop).
+ /** If cursor is in a INetAttribute it will be deleted completely
+ including the descriptive text (needed at drag & drop). */
sal_Bool DelINetAttrWithText();
- // If Cursor is at the end of a character style in which the DontExpand-flag
- // is not yet set, the latter will be set (==> return TRUE).
+ /** If Cursor is at the end of a character style in which the DontExpand-flag
+ is not yet set, the latter will be set (==> return TRUE). */
sal_Bool DontExpandFmt();
- // Apply / remove attributes.
- // Returns attributs in required AttributeSet.
- // When not unambiguous the set has a DONT_CARE !!
- // 2nd optional parameter <bMergeIndentValuesOfNumRule>.
- // If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
- // the corresponding list level of an applied list style is merged into
- // the requested item set as a LR-SPACE item, if corresponding node has not
- // its own indent attributes and the position-and-space mode of the list
- // level is SvxNumberFormat::LABEL_ALIGNMENT.
+ /** Apply / remove attributes.
+ @return attributs in required AttributeSet.
+ When not unambiguous the set has a DONT_CARE !!
+ 2nd optional parameter <bMergeIndentValuesOfNumRule>.
+ If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
+ the corresponding list level of an applied list style is merged into
+ the requested item set as a LR-SPACE item, if corresponding node has not
+ its own indent attributes and the position-and-space mode of the list
+ level is SvxNumberFormat::LABEL_ALIGNMENT. */
sal_Bool GetPaMAttr( SwPaM* pPaM, SfxItemSet& ,
const bool bMergeIndentValuesOfNumRule = false ) const;
sal_Bool GetCurAttr( SfxItemSet& ,
@@ -280,27 +280,27 @@ public:
*/
sal_Bool GetPaMParAttr( SwPaM* pPaM, SfxItemSet& rSet ) const;
- // Set attribute as new default attribute in document.
+ /// Set attribute as new default attribute in document.
void SetDefault( const SfxPoolItem& );
- // Query default attribute of document.
+ /// Query default attribute of document.
const SfxPoolItem& GetDefault( sal_uInt16 nFmtHint ) const;
void ResetAttr( const std::set<sal_uInt16> &attrs = std::set<sal_uInt16>(), SwPaM* pCrsr = NULL );
void GCAttr();
- // Returns the scripttpye of the selection.
+ /// @return the scripttpye of the selection.
sal_uInt16 GetScriptType() const;
- // Returns the language at current cursor position.
+ /// @return the language at current cursor position.
sal_uInt16 GetCurLang() const;
- // TABLE
+ /// TABLE
sal_uInt16 GetTblFrmFmtCount( sal_Bool bUsed = sal_False ) const;
SwFrmFmt& GetTblFrmFmt(sal_uInt16 nFmt, sal_Bool bUsed = sal_False ) const;
String GetUniqueTblName() const;
- // CHAR
+ /// CHAR
sal_uInt16 GetCharFmtCount() const;
SwCharFmt& GetCharFmt(sal_uInt16 nFmt) const;
SwCharFmt* GetCurCharFmt() const;
@@ -345,7 +345,7 @@ public:
SwTxtFmtColl* GetPaMTxtFmtColl( SwPaM* pPaM ) const;
// #i62675#
- // Add 2nd optional parameter <bResetListAttrs> - see also <SwDoc::SetTxtFmtColl(..)>
+ /// Add 2nd optional parameter <bResetListAttrs> - see also <SwDoc::SetTxtFmtColl(..)>
void SetTxtFmtColl( SwTxtFmtColl*,
bool bResetListAttrs = false );
SwTxtFmtColl *MakeTxtFmtColl(const String &rFmtCollName,
@@ -353,19 +353,19 @@ public:
void FillByEx(SwTxtFmtColl*, sal_Bool bReset = sal_False);
SwTxtFmtColl* FindTxtFmtCollByName( const String& rName ) const;
- // Return "Auto-Collection" with given Id. If it does not exist create it.
+ /// @return "Auto-Collection" with given Id. If it does not exist create it.
SwTxtFmtColl* GetTxtCollFromPool( sal_uInt16 nId );
- // Return required automatic format base class.
+ /// @return required automatic format base class.
SwFmt* GetFmtFromPool( sal_uInt16 nId );
- // Return required automatic page style.
+ /// @return required automatic page style.
SwPageDesc* GetPageDescFromPool( sal_uInt16 nId );
- // Query if the paragraph-/character-/frame-/page-style is used.
+ /// Query if the paragraph-/character-/frame-/page-style is used.
sal_Bool IsUsed( const SwModify& ) const;
- // Return required automatic format.
+ /// @return required automatic format.
SwFrmFmt* GetFrmFmtFromPool( sal_uInt16 nId )
{ return (SwFrmFmt*)SwEditShell::GetFmtFromPool( nId ); }
SwCharFmt* GetCharFmtFromPool( sal_uInt16 nId )
@@ -374,7 +374,7 @@ public:
void Insert2(SwField&, const bool bForceExpandHints = false);
SwField* GetCurFld() const;
- void UpdateFlds( SwField & ); // One single field.
+ void UpdateFlds( SwField & ); ///< One single field.
sal_uInt16 GetFldTypeCount(sal_uInt16 nResId = USHRT_MAX, sal_Bool bUsed = sal_False) const;
SwFieldType* GetFldType(sal_uInt16 nId, sal_uInt16 nResId = USHRT_MAX, sal_Bool bUsed = sal_False) const;
@@ -387,7 +387,7 @@ public:
void ChangeAuthorityData(const SwAuthEntry* pNewData);
- // Database information.
+ /// Database information.
SwDBData GetDBData() const;
const SwDBData& GetDBDesc() const;
void ChgDBData(const SwDBData& SwDBData);
@@ -398,27 +398,27 @@ public:
sal_Bool IsAnyDatabaseFieldInDoc()const;
- // Check whether DB fields point to an available data source and returns it.
+ /// Check whether DB fields point to an available data source and returns it.
sal_Bool IsFieldDataSourceAvailable(String& rUsedDataSource) const;
- void UpdateExpFlds(sal_Bool bCloseDB = sal_False);// nur alle ExpressionFelder updaten
+ void UpdateExpFlds(sal_Bool bCloseDB = sal_False);///< only every expression fields update
void LockExpFlds();
void UnlockExpFlds();
SwFldUpdateFlags GetFldUpdateFlags(sal_Bool bDocSettings = sal_False) const;
void SetFldUpdateFlags( SwFldUpdateFlags eFlags );
- // For evaluation of DB fields (new DB-manager).
+ /// For evaluation of DB fields (new DB-manager).
SwNewDBMgr* GetNewDBMgr() const;
SwFieldType* InsertFldType(const SwFieldType &);
- // Changes in document?
+ /// Changes in document?
sal_Bool IsModified() const;
void SetModified();
void ResetModified();
void SetUndoNoResetModified();
- // Document - Statistics
+ /// Document - Statistics
void UpdateDocStat();
const SwDocStat &GetUpdatedDocStat();
@@ -426,10 +426,10 @@ public:
void DeleteTOXMark(SwTOXMark* pMark);
- // Get all marks at current SPoint.
+ /// Get all marks at current SPoint.
sal_uInt16 GetCurTOXMarks(SwTOXMarks& rMarks) const ;
- // Insert content table. Renew if required.
+ /// Insert content table. Renew if required.
void InsertTableOf(const SwTOXBase& rTOX,
const SfxItemSet* pSet = 0);
sal_Bool UpdateTableOf(const SwTOXBase& rTOX,
@@ -445,21 +445,21 @@ public:
const SwTOXBase* GetTOX( sal_uInt16 nPos ) const;
sal_Bool DeleteTOX( const SwTOXBase& rTOXBase, sal_Bool bDelNodes = sal_False );
- // After reading file update all content tables.
+ /// After reading file update all content tables.
void SetUpdateTOX( sal_Bool bFlag = sal_True );
sal_Bool IsUpdateTOX() const;
- // Manage types of content tables.
+ /// Manage types of content tables.
sal_uInt16 GetTOXTypeCount(TOXTypes eTyp) const;
const SwTOXType* GetTOXType(TOXTypes eTyp, sal_uInt16 nId) const;
void InsertTOXType(const SwTOXType& rTyp);
- // AutoMark file
+ /// AutoMark file
const String& GetTOIAutoMarkURL() const;
void SetTOIAutoMarkURL(const String& rSet);
void ApplyAutoMark();
- // Key for managing index.
+ /// Key for managing index.
sal_uInt16 GetTOIKeys( SwTOIKeyType eTyp, std::vector<String>& rArr ) const;
void SetOutlineNumRule(const SwNumRule&);
@@ -471,29 +471,29 @@ public:
sal_Bool IsProtectedOutlinePara() const;
- // Returns numbering rulse pf current enumeration list (else FALSE).
+ /// @return numbering rulse pf current enumeration list (else FALSE).
const SwNumRule* GetCurNumRule() const;
- // If there is not already a numbering, set one, else change.
- // Works with old and new rules. Update only differences.
- // Add optional parameter <bResetIndentAttrs> (default value sal_False).
- // If <bResetIndentAttrs> equals true, the indent attributes "before text"
- // and "first line indent" are additionally reset at the current selection,
- // if the list style makes use of the new list level attributes.
- // introduce parameters <bCreateNewList> and <sContinuedListId>
- // <bCreateNewList> indicates, if a new list is created by applying the
- // given list style.
- // If <bCreateNewList> equals sal_False, <sContinuedListId> may contain the
- // list Id of a list, which has to be continued by applying the given list style.
+ /** If there is not already a numbering, set one, else change.
+ Works with old and new rules. Update only differences.
+ Add optional parameter @param <bResetIndentAttrs> (default value sal_False).
+ If @param <bResetIndentAttrs> equals true, the indent attributes "before text"
+ and "first line indent" are additionally reset at the current selection,
+ if the list style makes use of the new list level attributes.
+ introduce parameters @param <bCreateNewList> and @param <sContinuedListId>
+ @param <bCreateNewList> indicates, if a new list is created by applying the
+ given list style.
+ If @param <bCreateNewList> equals sal_False, @param <sContinuedListId> may contain the
+ list Id of a list, which has to be continued by applying the given list style. */
void SetCurNumRule( const SwNumRule&,
const bool bCreateNewList /*= false*/,
const String sContinuedListId = String(),
const bool bResetIndentAttrs = false );
- // Paragraphs without enumeration but with indents.
+ /// Paragraphs without enumeration but with indents.
sal_Bool NoNum();
- // Delete, split enumeration list.
+ /// Delete, split enumeration list.
void DelNumRules();
sal_Bool NumUpDown( sal_Bool bDown = sal_True );
@@ -501,12 +501,12 @@ public:
sal_Bool MoveParagraph( long nOffset = 1);
sal_Bool MoveNumParas( sal_Bool bUpperLower, sal_Bool bUpperLeft );
- // Switch on/off of numbering via Delete/Backspace.
+ /// Switch on/off of numbering via Delete/Backspace.
sal_Bool NumOrNoNum( sal_Bool bDelete = sal_False, sal_Bool bChkStart = sal_True);
// #i23726#
// #i90078#
- // Remove unused default parameter <nLevel> and <bRelative>.
+ /// Remove unused default parameter <nLevel> and <bRelative>.
// Adjust method name and parameter name
void ChangeIndentOfAllListLevels( short nDiff );
// Adjust method name
@@ -516,16 +516,16 @@ public:
sal_Bool IsNoNum( sal_Bool bChkStart = sal_True ) const;
- // Return Num-Level of the node in which point of cursor is.
- // Return values can be: NO_NUMBERING,
- // 0..MAXLEVEL-1, NO_NUMLEVEL .. NO_NUMLEVEL|MAXLEVEL-1
+ /** @return Num-Level of the node in which point of cursor is.
+ @return values can be: NO_NUMBERING,
+ 0..MAXLEVEL-1, NO_NUMLEVEL .. NO_NUMLEVEL|MAXLEVEL-1 */
sal_uInt8 GetNumLevel() const;
- // Detect highest and lowest level to check moving of outline levels.
+ /// Detect highest and lowest level to check moving of outline levels.
void GetCurrentOutlineLevels( sal_uInt8& rUpper, sal_uInt8& rLower );
- // Get Outline level of current paragraph.
+ /// Get Outline level of current paragraph.
int GetCurrentParaOutlineLevel( ) const;// #outlinelevel add by zhaojianwei
// i29560
@@ -535,7 +535,7 @@ public:
String GetUniqueNumRuleName( const String* pChkStr = 0, sal_Bool bAutoNum = sal_True ) const;
void ChgNumRuleFmts( const SwNumRule& rRule );
- // Set (and query if) a numbering with StartFlag starts at current PointPos.
+ /// Set (and query if) a numbering with StartFlag starts at current PointPos.
void SetNumRuleStart( sal_Bool bFlag = sal_True, SwPaM* pCrsr = NULL );
sal_Bool IsNumRuleStart( SwPaM* pPaM = NULL ) const;
void SetNodeNumStart( sal_uInt16 nStt, SwPaM* = NULL );
@@ -544,28 +544,28 @@ public:
sal_Bool ReplaceNumRule( const String& rOldRule, const String& rNewRule );
- // Searches for a text node with a numbering rule.
- // in case a list style is found, <sListId> holds the list id, to which the
- // text node belongs, which applies the found list style.
+ /** Searches for a text node with a numbering rule.
+ in case a list style is found, <sListId> holds the list id, to which the
+ text node belongs, which applies the found list style. */
const SwNumRule * SearchNumRule(const bool bForward,
const bool bNum,
const bool bOutline,
int nNonEmptyAllowed,
String& sListId );
- // Undo.
- // Maintain UndoHistory in Document.
- // Reset UndoHistory at Save, SaveAs, Create ???
+ /** Undo.
+ Maintain UndoHistory in Document.
+ Reset UndoHistory at Save, SaveAs, Create ??? */
void DoUndo( sal_Bool bOn = sal_True );
sal_Bool DoesUndo() const;
void DoGroupUndo( sal_Bool bUn = sal_True );
sal_Bool DoesGroupUndo() const;
void DelAllUndoObj();
- // Undo: set up Undo parenthesis, return nUndoId of this parenthesis.
+ /// Undo: set up Undo parenthesis, return nUndoId of this parenthesis.
SwUndoId StartUndo( SwUndoId eUndoId = UNDO_EMPTY, const SwRewriter * pRewriter = 0 );
- // Closes parenthesis of nUndoId, not used by UI.
+ /// Closes parenthesis of nUndoId, not used by UI.
SwUndoId EndUndo( SwUndoId eUndoId = UNDO_EMPTY, const SwRewriter * pRewriter = 0 );
bool GetLastUndoInfo(::rtl::OUString *const o_pStr,
@@ -584,30 +584,30 @@ public:
bool Repeat(sal_uInt16 const nCount);
- // For all views of this document.
+ /// For all views of this document.
void StartAllAction();
void EndAllAction();
- // To enable set up of StartActions and EndActions.
+ /// To enable set up of StartActions and EndActions.
void CalcLayout();
- // Determine form of content. Return Type at CurCrsr->SPoint.
+ /// Determine form of content. Return Type at CurCrsr->SPoint.
sal_uInt16 GetCntType() const;
- // Are there frames, footnotes, etc.
+ /// Are there frames, footnotes, etc.
sal_Bool HasOtherCnt() const;
- // Apply ViewOptions with Start-/EndAction.
+ /// Apply ViewOptions with Start-/EndAction.
virtual void ApplyViewOptions( const SwViewOption &rOpt );
- // Query text within selection.
- // Returns FALSE, if selected range is too large to be copied
- // into string buffer or if other errors occur.
+ /** Query text within selection.
+ @returns FALSE, if selected range is too large to be copied
+ into string buffer or if other errors occur. */
sal_Bool GetSelectedText( String &rBuf,
int nHndlParaBreak = GETSELTXT_PARABRK_TO_BLANK );
- // Returns graphic, if CurCrsr->Point() points to a SwGrfNode
- // (and mark is not set or points to the same graphic).
+ /** @return graphic, if CurCrsr->Point() points to a SwGrfNode
+ (and mark is not set or points to the same graphic). */
const Graphic* GetGraphic( sal_Bool bWait = sal_True ) const;
const GraphicObject* GetGraphicObj() const;
@@ -618,84 +618,84 @@ public:
const PolyPolygon *GetGraphicPolygon() const;
void SetGraphicPolygon( const PolyPolygon *pPoly );
- // If there's an automatic, not manipulated polygon at the selected
- // notxtnode, it has to be deleted, e.g. cause the object has changed.
+ /** If there's an automatic, not manipulated polygon at the selected
+ notxtnode, it has to be deleted, e.g. cause the object has changed. */
void ClearAutomaticContour();
- // Returns the size of a graphic in Twips if cursor is in a graphic.
+ /// @return the size of a graphic in Twips if cursor is in a graphic.
sal_Bool GetGrfSize(Size&) const;
- // Returns name and filter of a graphic if the cursor is in a graphic,
- // else give a rap on the knuckles!
- // If a string-ptr != 0 return the respective name.
+ /** @return name and filter of a graphic if the cursor is in a graphic,
+ else give a rap on the knuckles!
+ If a string-ptr != 0 return the respective name. */
void GetGrfNms( String* pGrfName, String* pFltName,
const SwFlyFrmFmt* = 0 ) const;
- // Re-read if graphic is not ok. Current graphic is replaced by the new one.
+ /// Re-read if graphic is not ok. Current graphic is replaced by the new one.
void ReRead( const String& rGrfName, const String& rFltName,
const Graphic* pGraphic = 0,
const GraphicObject* pGrafObj = 0 );
- // Unique identification of object (for ImageMapDlg).
+ /// Unique identification of object (for ImageMapDlg).
void *GetIMapInventor() const;
// #i73788#
- // Remove default parameter, because method always called this default value.
- Graphic GetIMapGraphic() const; // Returns a graphic for all Flys!
+ /// Remove default parameter, because method always called this default value.
+ Graphic GetIMapGraphic() const; ///< @return a graphic for all Flys!
const SwFlyFrmFmt* FindFlyByName( const String& rName, sal_uInt8 nNdTyp = 0 ) const;
- // Returns a ClientObject, if CurCrsr->Point() points to a SwOLENode
- // (and mark is neither set not pointint to same ClientObject)
- // else give rap on the knuckles.
+ /** @return a ClientObject, if CurCrsr->Point() points to a SwOLENode
+ (and mark is neither set not pointint to same ClientObject)
+ else give rap on the knuckles. */
svt::EmbeddedObjectRef& GetOLEObject() const;
- // Is there an OLEObject with this name (SwFmt)?
+ /// Is there an OLEObject with this name (SwFmt)?
sal_Bool HasOLEObj( const String &rName ) const;
- // Returns pointer to the data of the chart in which Cursr is.
+ /// @return pointer to the data of the chart in which Cursr is.
void SetChartName( const String &rName );
- // Update content of all charts for table with given name.
+ /// Update content of all charts for table with given name.
void UpdateCharts( const String &rName );
String GetCurWord();
- // Glossary from glossary document in current document.
- // Styles only if not already existent.
+ /** Glossary from glossary document in current document.
+ Styles only if not already existent. */
void InsertGlossary( SwTextBlocks& rGlossary, const String& );
- // Make current selection glossary and insert into glossary document
- // including styles.
+ /** Make current selection glossary and insert into glossary document
+ including styles. */
sal_uInt16 MakeGlossary( SwTextBlocks& rToFill, const String& rName,
const String& rShortName, sal_Bool bSaveRelFile = sal_False,
const String* pOnlyTxt=0 );
- // Save complete content of doc as glossary.
+ /// Save complete content of doc as glossary.
sal_uInt16 SaveGlossaryDoc( SwTextBlocks& rGlossary, const String& rName,
const String& rShortName,
sal_Bool bSaveRelFile = sal_False,
sal_Bool bOnlyTxt = sal_False );
// Linguistics...
- // Save selections.
+ /// Save selections.
void HyphStart( SwDocPositions eStart, SwDocPositions eEnde );
- // restore selections.
+ /// restore selections.
void HyphEnd();
com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>
HyphContinue( sal_uInt16* pPageCnt, sal_uInt16* pPageSt );
void HyphIgnore();
- // For Inserting SoftHyphen. Position is offset within the syllabificated word.
+ /// For Inserting SoftHyphen. Position is offset within the syllabificated word.
void InsertSoftHyph( const xub_StrLen nHyphPos );
- const SwTable& InsertTable( const SwInsertTableOptions& rInsTblOpts, // ALL_TBL_INS_ATTR
+ const SwTable& InsertTable( const SwInsertTableOptions& rInsTblOpts, ///< ALL_TBL_INS_ATTR
sal_uInt16 nRows, sal_uInt16 nCols,
sal_Int16 eAdj = com::sun::star::text::HoriOrientation::FULL,
const SwTableAutoFmt* pTAFmt = 0 );
- void InsertDDETable( const SwInsertTableOptions& rInsTblOpts, // HEADLINE_NO_BORDER
+ void InsertDDETable( const SwInsertTableOptions& rInsTblOpts, ///< HEADLINE_NO_BORDER
SwDDEFieldType* pDDEType,
sal_uInt16 nRows, sal_uInt16 nCols,
sal_Int16 eAdj = com::sun::star::text::HoriOrientation::FULL );
@@ -704,7 +704,7 @@ public:
void SetTableName( SwFrmFmt& rTblFmt, const String &rNewName );
SwFrmFmt *GetTableFmt();
- sal_Bool TextToTable( const SwInsertTableOptions& rInsTblOpts, //ALL_TBL_INS_ATTR
+ sal_Bool TextToTable( const SwInsertTableOptions& rInsTblOpts, ///< ALL_TBL_INS_ATTR
sal_Unicode cCh,
sal_Int16 eAdj = com::sun::star::text::HoriOrientation::FULL,
const SwTableAutoFmt* pTAFmt = 0 );
@@ -720,51 +720,51 @@ public:
TblChgMode GetTblChgMode() const;
void SetTblChgMode( TblChgMode eMode );
- // Split table at cursor position.
+ /// Split table at cursor position.
sal_Bool SplitTable( sal_uInt16 eMode );
- // Merge tables.
+ /** Merge tables.
- // Can Merge checks if Prev or Next are possible.
- // If pointer pChkNxtPrv is passed possible direction is given.
+ Can Merge checks if Prev or Next are possible.
+ If pointer pChkNxtPrv is passed possible direction is given. */
sal_Bool CanMergeTable( sal_Bool bWithPrev = sal_True, sal_Bool* pChkNxtPrv = 0 ) const;
sal_Bool MergeTable( sal_Bool bWithPrev = sal_True, sal_uInt16 nMode = 0 );
- // Set up InsertDB as table Undo.
+ /// Set up InsertDB as table Undo.
void AppendUndoForInsertFromDB( sal_Bool bIsTable );
- // Functions used for spell checking and text conversion.
+ /// Functions used for spell checking and text conversion.
- // Save selections.
+ /// Save selections.
void SpellStart( SwDocPositions eStart, SwDocPositions eEnde,
SwDocPositions eCurr, SwConversionArgs *pConvArgs = 0 );
- // Restore selections.
+ /// Restore selections.
void SpellEnd( SwConversionArgs *pConvArgs = 0, bool bRestoreSelection = true );
::com::sun::star::uno::Any SpellContinue(
sal_uInt16* pPageCnt, sal_uInt16* pPageSt,
SwConversionArgs *pConvArgs = 0 );
- // Spells on a sentence basis - the SpellPortions are needed
- // returns false if no error could be found.
+ /** Spells on a sentence basis - the SpellPortions are needed
+ @return false if no error could be found. */
bool SpellSentence(::svx::SpellPortions& rToFill, bool bIsGrammarCheck );
- // Make SpellIter start with the current sentence when called next time.
+ /// Make SpellIter start with the current sentence when called next time.
void PutSpellingToSentenceStart();
- // Moves the continuation position to the end of the currently checked sentence.
+ /// Moves the continuation position to the end of the currently checked sentence.
void MoveContinuationPosToEndOfCheckedSentence();
- // Applies a changed sentence.
+ /// Applies a changed sentence.
void ApplyChangedSentence(const ::svx::SpellPortions& rNewPortions, bool bRecheck);
- // Check SwSpellIter data to see if the last sentence got grammar checked.
+ /// Check SwSpellIter data to see if the last sentence got grammar checked.
bool HasLastSentenceGotGrammarChecked() const;
- // Is text conversion active somewhere else?
+ /// Is text conversion active somewhere else?
sal_Bool HasConvIter() const;
- // Is hyphenation active somewhere else?
+ /// Is hyphenation active somewhere else?
sal_Bool HasHyphIter() const;
::com::sun::star::uno::Reference<
@@ -781,25 +781,25 @@ public:
void IgnoreGrammarErrorAt( SwPaM& rErrorPosition );
void SetLinguRange( SwDocPositions eStart, SwDocPositions eEnde );
- // Return reference set in document according to given name.
+ /// @return reference set in document according to given name.
const SwFmtRefMark* GetRefMark( const String& rName ) const;
- // Return names of all references set in document.
- // If ArrayPointer == 0 then return only whether a RefMark is set in document.
+ /** @return names of all references set in document.
+ If ArrayPointer == 0 then return only whether a RefMark is set in document. */
sal_uInt16 GetRefMarks( std::vector<rtl::OUString>* = 0 ) const;
- // Call AutoCorrect
+ /// Call AutoCorrect
void AutoCorrect( SvxAutoCorrect& rACorr, sal_Bool bInsertMode = sal_True,
sal_Unicode cChar = ' ' );
sal_Bool GetPrevAutoCorrWord( SvxAutoCorrect& rACorr, String& rWord );
- // Set our styles according to the respective rules.
+ /// Set our styles according to the respective rules.
void AutoFormat( const SvxSwAutoFmtFlags* pAFlags = 0 );
static SvxSwAutoFmtFlags* GetAutoFmtFlags();
static void SetAutoFmtFlags(SvxSwAutoFmtFlags *);
- // Calculates selection.
+ /// Calculates selection.
String Calculate();
sal_Bool InsertURL( const SwFmtINetFmt& rFmt, const String& rStr,
@@ -809,31 +809,31 @@ public:
String GetDropTxt( const sal_uInt16 nChars ) const;
void ReplaceDropTxt( const String &rStr, SwPaM* pPaM = NULL );
- // May an outline be moved or copied?
- // Check whether it's in text body, not in table, and not read-only (move).
+ /** May an outline be moved or copied?
+ Check whether it's in text body, not in table, and not read-only (move). */
sal_Bool IsOutlineMovable( sal_uInt16 nIdx ) const;
sal_Bool IsOutlineCopyable( sal_uInt16 nIdx ) const;
sal_uInt16 GetLineCount( sal_Bool bActPos = sal_True );
- // Query and set footnote-text/number. Set.. to current SSelection!
+ /// Query and set footnote-text/number. Set.. to current SSelection!
sal_Bool GetCurFtn( SwFmtFtn* pToFillFtn = 0 );
bool SetCurFtn( const SwFmtFtn& rFillFtn );
bool HasFtns( bool bEndNotes = false ) const;
sal_uInt16 GetSeqFtnList( SwSeqFldList& rList, bool bEndNotes = false );
- // Return list of all footnotes and their first portions of text.
+ /// @return list of all footnotes and their first portions of text.
SwSection const* InsertSection(
SwSectionData & rNewData, SfxItemSet const*const = 0 );
sal_Bool IsInsRegionAvailable() const;
const SwSection* GetCurrSection() const;
- // Returns current range like Cet CurrSection(). But this function iterates
- // also over frames and catches the range even if the cursor is positioned in
- // a footnote the reference of which is in a columned range.
- // If bOutOfTab is set, the range comprising the table is searched
- // and not an inner one.
+ /** @return current range like Cet CurrSection(). But this function iterates
+ also over frames and catches the range even if the cursor is positioned in
+ a footnote the reference of which is in a columned range.
+ If bOutOfTab is set, the range comprising the table is searched
+ and not an inner one. */
const SwSection* GetAnySection( sal_Bool bOutOfTab = sal_False, const Point* pPt = 0 ) const;
sal_uInt16 GetSectionFmtCount() const;
@@ -848,40 +848,40 @@ public:
String GetUniqueSectionName( const String* pChkStr = 0 ) const;
- // Set attributes.
+ /// Set attributes.
void SetSectionAttr(const SfxItemSet& rSet, SwSectionFmt* pSectFmt = 0);
- // Search inside the cursor selection for full selected sections.
- // if any part of section in the selection return 0.
- // if more than one in the selection return the count.
+ /** Search inside the cursor selection for full selected sections.
+ if any part of section in the selection @return 0.
+ if more than one in the selection return the count. */
sal_uInt16 GetFullSelectedSectionCount() const;
- // Special insert: Insert a new text node just before or after a section or
- // table, if the cursor is positioned at the start/end of said
- // section/table. The purpose of the method is to allow users to inert text
- // at certain 'impossible' position, e.g. before a table at the document
- // start or between to sections.
+ /** Special insert: Insert a new text node just before or after a section or
+ table, if the cursor is positioned at the start/end of said
+ section/table. The purpose of the method is to allow users to inert text
+ at certain 'impossible' position, e.g. before a table at the document
+ start or between to sections. */
bool DoSpecialInsert();
bool CanSpecialInsert() const;
- // Optimizing UI.
+ /// Optimizing UI.
void SetNewDoc(sal_Bool bNew = sal_True);
sfx2::LinkManager& GetLinkManager();
inline const sfx2::LinkManager& GetLinkManager() const;
- // Adjust left margin via object bar (similar to adjustment of numerations).
- // One can either change the margin "by" adding or substracting a given
- // offset or set it "to" this position (bModulus = sal_True).
+ /** Adjust left margin via object bar (similar to adjustment of numerations).
+ One can either change the margin "by" adding or substracting a given
+ offset or set it "to" this position @param (bModulus = sal_True). */
sal_Bool IsMoveLeftMargin( sal_Bool bRight = sal_True, sal_Bool bModulus = sal_True ) const;
void MoveLeftMargin( sal_Bool bRight = sal_True, sal_Bool bModulus = sal_True );
- // Query NumberFormater from document.
+ /// Query NumberFormater from document.
SvNumberFormatter* GetNumberFormatter();
const SvNumberFormatter* GetNumberFormatter() const
{ return ((SwEditShell*)this)->GetNumberFormatter(); }
- // Interfaces for GlobalDocument.
+ /// Interfaces for GlobalDocument.
sal_Bool IsGlobalDoc() const;
void SetGlblDocSaveLinks( sal_Bool bFlag = sal_True );
sal_Bool IsGlblDocSaveLinks() const;
@@ -898,7 +898,7 @@ public:
sal_uInt16 nNewPos );
sal_Bool GotoGlobalDocContent( const SwGlblDocContent& rPos );
- // For Redlining.
+ /// For Redlining.
sal_uInt16 GetRedlineMode() const;
void SetRedlineMode( sal_uInt16 eMode );
sal_Bool IsRedlineOn() const;
@@ -908,25 +908,25 @@ public:
sal_Bool RejectRedline( sal_uInt16 nPos );
- // Search Redline for this Data and return position in array.
- // If not found, return USHRT_MAX.
+ /** Search Redline for this Data and @return position in array.
+ If not found, return USHRT_MAX. */
sal_uInt16 FindRedlineOfData( const SwRedlineData& ) const;
- // Set comment to Redline at position.
+ /// Set comment to Redline at position.
sal_Bool SetRedlineComment( const String& rS );
const SwRedline* GetCurrRedline() const;
- // Redline attributes have been changed. Updated views.
+ /// Redline attributes have been changed. Updated views.
void UpdateRedlineAttr();
- // Compare two documents.
+ /// Compare two documents.
long CompareDoc( const SwDoc& rDoc );
- // Merge two documents.
+ /// Merge two documents.
long MergeDoc( const SwDoc& rDoc );
- // Footnote attributes global to document.
+ /// Footnote attributes global to document.
const SwFtnInfo& GetFtnInfo() const;
void SetFtnInfo(const SwFtnInfo& rInfo);
const SwEndNoteInfo& GetEndNoteInfo() const;
@@ -935,31 +935,31 @@ public:
const SwLineNumberInfo &GetLineNumberInfo() const;
void SetLineNumberInfo( const SwLineNumberInfo& rInfo);
- // Labels: Synchronize ranges.
+ /// Labels: Synchronize ranges.
void SetLabelDoc( sal_Bool bFlag = sal_True );
sal_Bool IsLabelDoc() const;
- // Interface for TextInputData - (for input of Japanese/Chinese chars.)
+ /// Interface for TextInputData - (for input of Japanese/Chinese chars.)
SwExtTextInput* CreateExtTextInput(LanguageType eInputLanguage);
String DeleteExtTextInput( SwExtTextInput* pDel = 0, sal_Bool bInsText = sal_True);
void SetExtTextInputData( const CommandExtTextInputData& );
- // Interface for access to AutoComplete-list.
+ /// Interface for access to AutoComplete-list.
static SwAutoCompleteWord& GetAutoCompleteWords();
- // Returns a scaling factor of selected text. Used for the rotated
- // character attribut dialog.
+ /** @return a scaling factor of selected text. Used for the rotated
+ character attribut dialog. */
sal_uInt16 GetScalingOfSelectedText() const;
- // Ctor/Dtor.
+ /// Ctor/Dtor.
SwEditShell( SwDoc&, Window*, const SwViewOption *pOpt = 0 );
- // Copy-Constructor in disguise.
+ /// Copy-Constructor in disguise.
SwEditShell( SwEditShell&, Window* );
virtual ~SwEditShell();
private:
- // For METWARE: no copying and no assignment.
+ /// For METWARE: no copying and no assignment.
SwEditShell(const SwEditShell &);
const SwEditShell &operator=(const SwEditShell &);
};
@@ -967,7 +967,7 @@ private:
inline const sfx2::LinkManager& SwEditShell::GetLinkManager() const
{ return ((SwEditShell*)this)->GetLinkManager(); }
-// Class for automated call of Start- and EndAction().
+ /// Class for automated call of Start- and EndAction().
class SwActKontext {
SwEditShell *pSh;
public:
@@ -977,7 +977,7 @@ public:
#define ACT_KONTEXT(x) SwActKontext _aActKontext_(x)
-// Class for automated call of Start- and EndCrsrMove().
+ /// Class for automated call of Start- and EndCrsrMove().
class SwMvKontext {
SwEditShell *pSh;
public:
diff --git a/sw/inc/expfld.hxx b/sw/inc/expfld.hxx
index ed7e9d5..8ddeb7e 100644
--- a/sw/inc/expfld.hxx
+++ b/sw/inc/expfld.hxx
@@ -44,7 +44,7 @@ class SwFmtFld;
class _SetGetExpFlds;
class SwEditShell;
-// Forward declaration: get "BodyTxtNode" for exp.fld in Fly's headers/footers/footnotes.
+/// Forward declaration: get "BodyTxtNode" for exp.fld in Fly's headers/footers/footnotes.
const SwTxtNode* GetBodyTxtNode( const SwDoc& pDoc, SwPosition& rPos,
const SwFrm& rFrm );
@@ -85,8 +85,8 @@ public:
SwGetExpFieldType(SwDoc* pDoc);
virtual SwFieldType* Copy() const;
- // Overlay, because get-field cannot be changed and therefore
- // does not need to be updated. Update at changing of set-values!
+ /** Overlay, because get-field cannot be changed and therefore
+ does not need to be updated. Update at changing of set-values! */
protected:
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew );
};
@@ -112,19 +112,19 @@ public:
inline const String& GetExpStr() const;
inline void ChgExpStr(const String& rExpand);
- // Called by formating.
+ /// Called by formating.
inline sal_Bool IsInBodyTxt() const;
- // Set by UpdateExpFlds where node position is known.
+ /// Set by UpdateExpFlds where node position is known.
inline void ChgBodyTxtFlag( sal_Bool bIsInBody );
- // For fields in header/footer/footnotes/flys:
- // Only called by formating!!
+ /** For fields in header/footer/footnotes/flys:
+ Only called by formating!! */
void ChangeExpansion( const SwFrm&, const SwTxtFld& );
virtual String GetFieldName() const;
- // Change formula.
+ /// Change formula.
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
@@ -144,11 +144,11 @@ inline void SwGetExpField::ChgExpStr(const String& rExpand)
inline const String& SwGetExpField::GetExpStr() const
{ return sExpand; }
-// Called by formating.
+ /// Called by formating.
inline sal_Bool SwGetExpField::IsInBodyTxt() const
{ return bIsInBodyTxt; }
-// Set by UpdateExpFlds where node position is known.
+ /// Set by UpdateExpFlds where node position is known.
inline void SwGetExpField::ChgBodyTxtFlag( sal_Bool bIsInBody )
{ bIsInBodyTxt = bIsInBody; }
@@ -181,7 +181,7 @@ public:
sal_Bool IsDeleted() const { return bDeleted; }
void SetDeleted( sal_Bool b ) { bDeleted = b; }
- // Overlay, because set-field takes care for its being updated by itself.
+ /// Overlay, because set-field takes care for its being updated by itself.
inline const rtl::OUString& GetSetRefName() const;
sal_uInt16 SetSeqRefNo( SwSetExpField& rFld );
@@ -189,15 +189,15 @@ public:
sal_uInt16 GetSeqFldList( SwSeqFldList& rList );
String MakeSeqName( sal_uInt16 nSeqNo );
- // Number sequence fields chapterwise if required.
+ /// Number sequence fields chapterwise if required.
const String& GetDelimiter() const { return sDelim; }
void SetDelimiter( const String& s ) { sDelim = s; }
sal_uInt8 GetOutlineLvl() const { return nLevel; }
void SetOutlineLvl( sal_uInt8 n ) { nLevel = n; }
void SetChapter( SwSetExpField& rFld, const SwNode& rNd );
- // Member only for SwDoc::UpdateExpFld.
- // It is needed only at runtime of sequence field types!
+ /** Member only for SwDoc::UpdateExpFld.
+ It is needed only at runtime of sequence field types! */
const SwNode* GetOutlineChgNd() const { return pOutlChgNd; }
void SetOutlineChgNd( const SwNode* p ) { pOutlChgNd = p; }
@@ -252,14 +252,14 @@ public:
inline sal_Bool IsSequenceFld() const;
- // Logical number, sequence fields.
+ /// Logical number, sequence fields.
inline void SetSeqNumber( sal_uInt16 n ) { nSeqNo = n; }
inline sal_uInt16 GetSeqNumber() const { return nSeqNo; }
- // Query name only.
+ /// Query name only.
virtual const rtl::OUString& GetPar1() const;
- // Query formula.
+ /// Query formula.
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt16 nWhich ) const;
@@ -312,18 +312,18 @@ class SW_DLLPUBLIC SwInputField : public SwField
virtual SwField* Copy() const;
public:
- // Direct input via dialog; delete old value.
+ /// Direct input via dialog; delete old value.
SwInputField(SwInputFieldType*, const String& rContent ,
const String& rPrompt, sal_uInt16 nSubType = 0,
sal_uLong nFmt = 0);
virtual String GetFieldName() const;
- // Content
+ /// Content
virtual const rtl::OUString& GetPar1() const;
virtual void SetPar1(const rtl::OUString& rStr);
- // aPromptText
+ /// aPromptText
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
@@ -358,9 +358,9 @@ public:
void PushCrsr();
void PopCrsr();
- // Put all that are new into SortLst for updating. Returns count.
- // (For Glossary: only update its input-fields).
- // Compare TmpLst with current fields.
+ /** Put all that are new into SortLst for updating. @return count.
+ (For Glossary: only update its input-fields).
+ Compare TmpLst with current fields. */
sal_uInt16 BuildSortLst();
void RemoveUnselectedFlds();
@@ -371,7 +371,7 @@ private:
std::set<const SwTxtFld*> aTmpLst;
};
-// Implementation in tblcalc.cxx.
+ /// Implementation in tblcalc.cxx.
class SwTblFieldType : public SwValueFieldType
{
public:
@@ -388,7 +388,7 @@ class SwTblField : public SwValueField, public SwTableFormula
virtual String Expand() const;
virtual SwField* Copy() const;
- // Search TextNode containing the field.
+ /// Search TextNode containing the field.
virtual const SwNode* GetNodeOfFormula() const;
String GetCommand();
@@ -408,7 +408,7 @@ public:
virtual String GetFieldName() const;
- // The formula.
+ /// The formula.
virtual rtl::OUString GetPar2() const;
virtual void SetPar2(const rtl::OUString& rStr);
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt16 nWhich ) const;
diff --git a/sw/inc/fchrfmt.hxx b/sw/inc/fchrfmt.hxx
index a6951cd..0a911f0 100644
--- a/sw/inc/fchrfmt.hxx
+++ b/sw/inc/fchrfmt.hxx
@@ -43,28 +43,28 @@ class IntlWrapper;
class SW_DLLPUBLIC SwFmtCharFmt: public SfxPoolItem, public SwClient
{
friend class SwTxtCharFmt;
- SwTxtCharFmt* pTxtAttr; // My text attribute.
+ SwTxtCharFmt* pTxtAttr; ///< My text attribute.
public:
SwFmtCharFmt() : pTxtAttr(0) {}
- // single argument ctors shall be explicit.
+ /// single argument ctors shall be explicit.
explicit SwFmtCharFmt( SwCharFmt *pFmt );
virtual ~SwFmtCharFmt();
- // @@@ public copy ctor, but no copy assignment?
+ /// @@@ public copy ctor, but no copy assignment?
SwFmtCharFmt( const SwFmtCharFmt& rAttr );
protected:
virtual void Modify( const SfxPoolItem*, const SfxPoolItem* );
private:
- // @@@ public copy ctor, but no copy assignment?
+ /// @@@ public copy ctor, but no copy assignment?
SwFmtCharFmt & operator= (const SwFmtCharFmt &);
public:
TYPEINFO();
- // "pure virtual methods" of SfxPoolItem
+ /// "pure virtual methods" of SfxPoolItem
virtual int operator==( const SfxPoolItem& ) const;
virtual SfxPoolItem* Clone( SfxItemPool* pPool = 0 ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
diff --git a/sw/inc/fesh.hxx b/sw/inc/fesh.hxx
index 058f912..17f4655 100644
--- a/sw/inc/fesh.hxx
+++ b/sw/inc/fesh.hxx
@@ -100,9 +100,9 @@ namespace svx
#define FLYPROTECT_CONTENT (sal_uInt16) 1
#define FLYPROTECT_SIZE (sal_uInt16) 2
#define FLYPROTECT_POS (sal_uInt16) 4
-#define FLYPROTECT_PARENT (sal_uInt16) 8 // Check only parents.
-#define FLYPROTECT_FIXED (sal_uInt16) 16 // Only protection that cannot be withdrawn
- // e.g. by OLE-server; also relevant for dialog.
+#define FLYPROTECT_PARENT (sal_uInt16) 8 /// Check only parents.
+#define FLYPROTECT_FIXED (sal_uInt16) 16 /** Only protection that cannot be withdrawn
+ e.g. by OLE-server; also relevant for dialog. */
// For figuring out contents by position (D&D)
enum ObjCntType
@@ -116,26 +116,26 @@ enum ObjCntType
OBJCNT_URLBUTTON,
OBJCNT_GROUPOBJ,
- OBJCNT_DONTCARE // Not determinable - different objects are selected.
+ OBJCNT_DONTCARE /// Not determinable - different objects are selected.
};
//For GetAnyCurRect
enum CurRectType
{
- RECT_PAGE, // Rect of current page.
- RECT_PAGE_CALC, // ... page will be formated if required.
- RECT_PAGE_PRT, // Rect of current PrtArea of page.
- RECT_FRM, // Rect of current frame.
- RECT_FLY_EMBEDDED, // Rect of current FlyFrm.
- RECT_FLY_PRT_EMBEDDED, // Rect of PrtArea of FlyFrm
- RECT_SECTION, // Rect of current section.
- RECT_OUTTABSECTION, // Rect of current section but outside of table.
- RECT_SECTION_PRT, // Rect of current PrtArea of section.
- RECT_OUTTABSECTION_PRT, // Rect of current PrtArea of section but outside table.
- RECT_HEADERFOOTER, // Rect of current header/footer
- RECT_HEADERFOOTER_PRT, // Rect of PrtArea of current headers/footers
-
- RECT_PAGES_AREA //Rect covering the pages area
+ RECT_PAGE, ///< Rect of current page.
+ RECT_PAGE_CALC, ///< ... page will be formated if required.
+ RECT_PAGE_PRT, ///< Rect of current PrtArea of page.
+ RECT_FRM, ///< Rect of current frame.
+ RECT_FLY_EMBEDDED, ///< Rect of current FlyFrm.
+ RECT_FLY_PRT_EMBEDDED, ///< Rect of PrtArea of FlyFrm
+ RECT_SECTION, ///< Rect of current section.
+ RECT_OUTTABSECTION, ///< Rect of current section but outside of table.
+ RECT_SECTION_PRT, ///< Rect of current PrtArea of section.
+ RECT_OUTTABSECTION_PRT, ///< Rect of current PrtArea of section but outside table.
+ RECT_HEADERFOOTER, ///< Rect of current header/footer
+ RECT_HEADERFOOTER_PRT, ///< Rect of PrtArea of current headers/footers
+
+ RECT_PAGES_AREA ///< Rect covering the pages area
};
struct SwGetCurColNumPara
@@ -183,15 +183,15 @@ class SW_DLLPUBLIC SwFEShell : public SwEditShell
SW_DLLPRIVATE SwFlyFrm *FindFlyFrm() const;
SW_DLLPRIVATE SwFlyFrm *FindFlyFrm( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& ) const;
- // Terminate actions for all shells and call ChangeLink.
+ /// Terminate actions for all shells and call ChangeLink.
SW_DLLPRIVATE void EndAllActionAndCall();
SW_DLLPRIVATE void ScrollTo( const Point &rPt );
SW_DLLPRIVATE void ChangeOpaque( SdrLayerID nLayerId );
- // Used for mouse operations on a table:
- // Returns a cell frame that is 'close' to rPt.
+ /** Used for mouse operations on a table:
+ @return a cell frame that is 'close' to rPt. */
SW_DLLPRIVATE const SwFrm *GetBox( const Point &rPt, bool* pbRow = 0, bool* pbCol = 0 ) const;
// 0 == not in any column.
@@ -205,13 +205,13 @@ class SW_DLLPUBLIC SwFEShell : public SwEditShell
SW_DLLPRIVATE ObjCntType GetObjCntType( const SdrObject& rObj ) const;
- // Methods for copying of draw objects.
+ /// Methods for copying of draw objects.
SW_DLLPRIVATE sal_Bool CopyDrawSel( SwFEShell* pDestShell, const Point& rSttPt,
const Point& rInsPt, sal_Bool bIsMove,
sal_Bool bSelectInsert );
- // Get list of marked SdrObjects;
- // helper method for GetSelFrmType, IsSelContainsControl.
+ /// Get list of marked SdrObjects;
+ /// helper method for GetSelFrmType, IsSelContainsControl.
SW_DLLPRIVATE const SdrMarkList* _GetMarkList() const;
SW_DLLPRIVATE sal_Bool CheckHeadline( bool bRepeat ) const;
@@ -227,61 +227,60 @@ public:
SwFEShell( SwEditShell& rShell, Window *pWin );
virtual ~SwFEShell();
- // Copy and Paste methods for internal clipboard.
+ /// Copy and Paste methods for internal clipboard.
sal_Bool Copy( SwDoc* pClpDoc, const String* pNewClpTxt = 0 );
sal_Bool Paste( SwDoc* pClpDoc, sal_Bool bIncludingPageFrames = sal_False);
- //Paste some pages into another doc - used in mailmerge.
+ /// Paste some pages into another doc - used in mailmerge.
sal_Bool PastePages( SwFEShell& rToFill, sal_uInt16 nStartPage, sal_uInt16 nEndPage);
- // Copy-Method for Drag&Drop
+ /// Copy-Method for Drag&Drop
sal_Bool Copy( SwFEShell*, const Point& rSttPt, const Point& rInsPt,
sal_Bool bIsMove = sal_False, sal_Bool bSelectInsert = sal_True );
void SelectFlyFrm( SwFlyFrm& rFrm, sal_Bool bNew = sal_False );
- // Is selected frame within another frame?
+ /// Is selected frame within another frame?
const SwFrmFmt* IsFlyInFly();
- // If an object as been given, exactly this object is selected
- // (instead of searching over position).
+ /** If an object as been given, exactly this object is selected
+ (instead of searching over position). */
sal_Bool SelectObj( const Point& rSelPt, sal_uInt8 nFlag = 0, SdrObject *pObj = 0 );
void DelSelectedObj();
- // Move selection upwards or downwards (Z-Order).
- // TRUE = to top or bottom.
- // FALSE = run past one other.
+ /** Move selection upwards or downwards (Z-Order).
+ TRUE = to top or bottom.
+ FALSE = run past one other. */
void SelectionToTop ( sal_Bool bTop = sal_True );
void SelectionToBottom( sal_Bool bBottom = sal_True );
- short GetLayerId() const; // 1 Heaven, 0 Hell, -1 Ambiguous.
- void SelectionToHeaven(); // Above document.
- void SelectionToHell(); // Below document.
+ short GetLayerId() const; ///< 1 Heaven, 0 Hell, -1 Ambiguous.
+ void SelectionToHeaven(); ///< Above document.
+ void SelectionToHell(); ///< Below document.
- // The following two methods return enum SdrHdlKind.
- // Declared as int in order to spare including SVDRAW.HXX.
+ /** The following two methods return enum SdrHdlKind.
+ Declared as int in order to spare including SVDRAW.HXX. */
bool IsObjSelectable( const Point& rPt );
/// Same as IsObjSelectable(), but return the object as well.
SdrObject* GetObjAt(const Point& rPt);
- int IsInsideSelectedObj( const Point& rPt ); //!! returns enum values
-
- // Test if there is a draw object at that position and if it should be selected.
- // The 'should' is aimed at Writer text fly frames which may be in front of
- // the draw object.
+ int IsInsideSelectedObj( const Point& rPt ); ///< returns enum values
+ /** Test if there is a draw object at that position and if it should be selected.
+ The 'should' is aimed at Writer text fly frames which may be in front of
+ the draw object. */
sal_Bool ShouldObjectBeSelected(const Point& rPt);
sal_Bool MoveAnchor( sal_uInt16 nDir );
- // Returns if Upper of frame at current position is section frame
- // Currently only used by the rules. To be replaced by something more
- // sophisticated one day.
+ /** @return if Upper of frame at current position is section frame
+ Currently only used by the rules. To be replaced by something more
+ sophisticated one day. */
bool IsDirectlyInSection() const;
- // For return valies see above FrmType.
- // pPt: Cursr or DocPos respectively; bStopAtFly: Stop at flys or continue over anchor.
- // Although (0,TRUE) is kind of a standard, the parameters are not defaulted here
- // in order to force more conscious use especially of bStopAtFly.
+ /** For return valies see above FrmType.
+ pPt: Cursr or DocPos respectively; bStopAtFly: Stop at flys or continue over anchor.
+ Although (0,TRUE) is kind of a standard, the parameters are not defaulted here
+ in order to force more conscious use especially of bStopAtFly. */
sal_uInt16 GetFrmType( const Point *pPt, sal_Bool bStopAtFly ) const;
sal_uInt16 GetSelFrmType() const; //Selektion (Drawing)
@@ -293,15 +292,15 @@ public:
ObjCntType GetObjCntType( const Point &rPt, SdrObject *&rpObj ) const;
ObjCntType GetObjCntTypeOfSelection( SdrObject** ppObj = 0 ) const;
- // For adjustment of PosAttr when anchor changes.
+ /// For adjustment of PosAttr when anchor changes.
SwRect GetObjRect() const;
- // For moving flys with keyboard.
+ /// For moving flys with keyboard.
SwRect GetFlyRect() const;
- // i#17567 - adjustments to allow negative vertical positions for fly frames anchored
- // to paragraph or to character.
- // i#18732 - adjustments for new option 'FollowTextFlow'
- // i#22341 - adjustments for new vertical alignment at top of line
+ /** i#17567 - adjustments to allow negative vertical positions for fly frames anchored
+ to paragraph or to character.
+ i#18732 - adjustments for new option 'FollowTextFlow'
+ i#22341 - adjustments for new vertical alignment at top of line */
void CalcBoundRect( SwRect& _orRect,
const RndStdIds _nAnchorId,
const sal_Int16 _eHoriRelOrient = com::sun::star::text::RelOrientation::FRAME,
@@ -312,7 +311,7 @@ public:
Point* _opRef = NULL,
Size* _opPercent = NULL ) const;
- // Set size of draw objects.
+ /// Set size of draw objects.
void SetObjRect( const SwRect& rRect );
long BeginDrag( const Point *pPt, sal_Bool bProp );
@@ -320,31 +319,31 @@ public:
long EndDrag ( const Point *pPt, sal_Bool bProp );
void BreakDrag();
- //Methods for status line.
+ /// Methods for status line.
Point GetAnchorObjDiff() const;
Point GetObjAbsPos() const;
Size GetObjSize() const;
- // SS for envelopes: get all page-bound objects and set them to new page.
+ /// SS for envelopes: get all page-bound objects and set them to new page.
void GetPageObjs( std::vector<SwFrmFmt*>& rFillArr );
void SetPageObjsNewPage( std::vector<SwFrmFmt*>& rFillArr, int nOffset = 1 );
- // Show current selection (frame / draw object as required).
+ /// Show current selection (frame / draw object as required).
virtual void MakeSelVisible();
- // Return FrmFmt of object that may be under Point.
- // Object does not become selected!
+ /** @return FrmFmt of object that may be under Point.
+ Object does not become selected! */
const SwFrmFmt* GetFmtFromObj( const Point& rPt, SwRect** pRectToFill = 0 ) const;
- // Returns a format too, if the point is over the text of any fly.
+ /// @return a format too, if the point is over the text of any fly.
const SwFrmFmt* GetFmtFromAnyObj( const Point& rPt ) const;
- // Which Protection is set at selected object?
- //!! returns several flags in sal_uInt8
+ /** Which Protection is set at selected object?
+ returns several flags in sal_uInt8 */
sal_uInt8 IsSelObjProtected( sal_uInt16 /*FLYPROTECT_...*/ eType ) const;
- // Deliver graphic in rName besides graphic name. If graphic is
- // linked give name with path. rbLink is TRUE if graphic is linked.
+ /** Deliver graphic in rName besides graphic name. If graphic is
+ linked give name with path. rbLink is TRUE if graphic is linked. */
const Graphic *GetGrfAtPos( const Point &rDocPos,
String &rName, sal_Bool &rbLink ) const;
@@ -363,89 +362,89 @@ public:
void SetFlyPos( const Point &rAbsPos);
Point FindAnchorPos( const Point &rAbsPos, sal_Bool bMoveIt = sal_False );
- // Determines whether a frame or its environment is vertically formatted and right-to-left.
- // also determines, if frame or its environmane is in mongolianlayout (vertical left-to-right)
- // - add output parameter <bVertL2R>
+ /** Determines whether a frame or its environment is vertically formatted and right-to-left.
+ also determines, if frame or its environmane is in mongolianlayout (vertical left-to-right)
+ - add output parameter <bVertL2R> */
sal_Bool IsFrmVertical(const sal_Bool bEnvironment, sal_Bool& bRightToLeft, sal_Bool& bVertL2R) const;
- SwFrmFmt* GetCurFrmFmt() const; //If frame then frame style, else 0.
- void SetFrmFmt( SwFrmFmt *pFmt, sal_Bool bKeepOrient = sal_False, Point* pDocPos = 0 ); //If frame then set frame style.
+ SwFrmFmt* GetCurFrmFmt() const; ///< If frame then frame style, else 0.
+ void SetFrmFmt( SwFrmFmt *pFmt, sal_Bool bKeepOrient = sal_False, Point* pDocPos = 0 ); ///< If frame then set frame style.
const SwFlyFrm *GetCurrFlyFrm() const { return FindFlyFrm(); }
- // Find/delete fly containing the cursor.
+ /// Find/delete fly containing the cursor.
SwFrmFmt* WizzardGetFly();
- // Independent selecting of flys.
+ /// Independent selecting of flys.
sal_Bool GotoNextFly( sal_uInt16 /*GOTOOBJ_...*/ eType = GOTOOBJ_FLY_ANY )
{ return GotoObj( sal_True, eType ); }
sal_Bool GotoPrevFly( sal_uInt16 /*GOTOOBJ_...*/ eType = GOTOOBJ_FLY_ANY)
{ return GotoObj( sal_False, eType); }
- // Iterate over flys - for Basic-collections.
+ /// Iterate over flys - for Basic-collections.
sal_uInt16 GetFlyCount( FlyCntType eType = FLYCNTTYPE_ALL ) const;
const SwFrmFmt* GetFlyNum(sal_uInt16 nIdx, FlyCntType eType = FLYCNTTYPE_ALL) const;
- // If a fly is selected, it draws cursor into the first CntntFrm.
+ /// If a fly is selected, it draws cursor into the first CntntFrm.
const SwFrmFmt* SelFlyGrabCrsr();
- //Get FlyFrameFormat; fuer UI Macro Anbindung an Flys
+ /// Get FlyFrameFormat; fuer UI Macro Anbindung an Flys
const SwFrmFmt* GetFlyFrmFmt() const;
SwFrmFmt* GetFlyFrmFmt();
- // OLE. Server requires new size. Desired values are adjusted as frame attributes.
- // If the values are not allowed, the formating clips and determines scaling.
- // See CalcAndSetScale().
- // The return value is the applied size.
+ /** OLE. Server requires new size. Desired values are adjusted as frame attributes.
+ If the values are not allowed, the formating clips and determines scaling.
+ See CalcAndSetScale().
+ The @return value is the applied size. */
Size RequestObjectResize( const SwRect &rRect, const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& );
- //The layout has been changed, so the active object has to be moved after that
+ /// The layout has been changed, so the active object has to be moved after that
virtual void MoveObjectIfActive( svt::EmbeddedObjectRef& xObj, const Point& rOffset );
- // Client for OleObject has to be up-to-date regarding scaling.
- // Implemented in WrtShell.
- // If a pointer is passed on a size, this is the object's current core-size.
- // Else the size is provided via GetCurFlyRect().
+ /** Client for OleObject has to be up-to-date regarding scaling.
+ Implemented in WrtShell.
+ If a pointer is passed on a size, this is the object's current core-size.
+ Else the size is provided via GetCurFlyRect(). */
virtual void CalcAndSetScale( svt::EmbeddedObjectRef& xObj,
const SwRect *pFlyPrtRect = 0,
const SwRect *pFlyFrmRect = 0,
const bool bNoTxtFrmPrtAreaChanged = false ) = 0;
- // Connect objects with ActivateWhenVisible at Paint.
- // Called by notxtfrm::Paint, implemented in wrtsh.
+ /** Connect objects with ActivateWhenVisible at Paint.
+ Called by notxtfrm::Paint, implemented in wrtsh. */
virtual void ConnectObj( svt::EmbeddedObjectRef&,
const SwRect &rPrt,
const SwRect &rFrm ) = 0;
- // Set visible range on object, if it is not yet visible.
+ /// Set visible range on object, if it is not yet visible.
void MakeObjVisible( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& ) const;
- // Check resize of OLE-Object.
+ /// Check resize of OLE-Object.
sal_Bool IsCheckForOLEInCaption() const { return bCheckForOLEInCaption; }
void SetCheckForOLEInCaption( sal_Bool bFlag ) { bCheckForOLEInCaption = bFlag; }
- // Set name at selected FlyFrame.
+ /// Set name at selected FlyFrame.
void SetFlyName( const String& rName );
const String& GetFlyName() const;
- // get reference to OLE object (if there is one) for selected FlyFrame
+ /// get reference to OLE object (if there is one) for selected FlyFrame
const com::sun::star::uno::Reference < com::sun::star::embed::XEmbeddedObject > GetOleRef() const;
- // Created unique name for frame.
+ /// Created unique name for frame.
String GetUniqueGrfName() const;
String GetUniqueOLEName() const;
String GetUniqueFrameName() const;
- // Jump to named Fly (graphic/OLE).
+ /// Jump to named Fly (graphic/OLE).
sal_Bool GotoFly( const String& rName, FlyCntType eType = FLYCNTTYPE_ALL,
sal_Bool bSelFrame = sal_True );
- // Position is a graphic with URL?
+ /// Position is a graphic with URL?
const SwFrmFmt* IsURLGrfAtPos( const Point& rPt, String* pURL = 0,
String *pTargetFrameName = 0,
String *pURLDescription = 0 ) const;
- // For Chain always connect Fly specified by format with that hit by point.
- // rRect contains rect of Fly (for its highlight).
+ /** For Chain always connect Fly specified by format with that hit by point.
+ rRect contains rect of Fly (for its highlight). */
int Chainable( SwRect &rRect, const SwFrmFmt &rSource, const Point &rPt ) const;
int Chain( SwFrmFmt &rSource, const Point &rPt );
int Chain( SwFrmFmt &rSource, const SwFrmFmt &rDest );
@@ -455,33 +454,33 @@ public:
Size GetGraphicDefaultSize() const;
- // Temporary work around for bug.
+ /// Temporary work around for bug.
void CheckUnboundObjects();
- // Attention: Ambiguities if multiple selections.
+ /// Attention: Ambiguities if multiple selections.
sal_Bool GetObjAttr( SfxItemSet &rSet ) const;
sal_Bool SetObjAttr( const SfxItemSet &rSet );
const SdrObject* GetBestObject( sal_Bool bNext, sal_uInt16 eType = GOTOOBJ_DRAW_ANY, sal_Bool bFlat = sal_True, const ::svx::ISdrObjectFilter* pFilter = NULL );
sal_Bool GotoObj( sal_Bool bNext, sal_uInt16 /*GOTOOBJ_...*/ eType = GOTOOBJ_DRAW_ANY);
- // Set DragMode (e.g. Rotae), but do nothing when frame is selected.
+ /// Set DragMode (e.g. Rotae), but do nothing when frame is selected.
void SetDragMode( sal_uInt16 eSdrDragMode );
- sal_uInt16 IsObjSelected() const; // Returns object count, but doesn't count the objects in groups.
+ sal_uInt16 IsObjSelected() const; ///< @return object count, but doesn't count the objects in groups.
sal_Bool IsObjSelected( const SdrObject& rObj ) const;
- void EndTextEdit(); // Deletes object if required.
+ void EndTextEdit(); ///< Deletes object if required.
- // Anchor type of selected object, -1 if ambiguous or in case of frame selection.
- // Else FLY_AT_PAGE or FLY_AT_PARA resp. from frmatr.hxx.
+ /** Anchor type of selected object, -1 if ambiguous or in case of frame selection.
+ Else FLY_AT_PAGE or FLY_AT_PARA resp. from frmatr.hxx. */
short GetAnchorId() const;
- // Process of creating draw objects. At the beginning object type is passed.
- // At the end a Cmd can be passed. Here, SDRCREATE_RESTRAINTEND for end
- // or SDRCREATE_NEXTPOINT for a polygon may be relevant.
- // After RESTRAINTEND the object is created and selected.
- // BreakCreate interrupts the process. In this case no object is selected.
+ /** Process of creating draw objects. At the beginning object type is passed.
+ At the end a Cmd can be passed. Here, SDRCREATE_RESTRAINTEND for end
+ or SDRCREATE_NEXTPOINT for a polygon may be relevant.
+ After RESTRAINTEND the object is created and selected.
+ BreakCreate interrupts the process. In this case no object is selected. */
sal_Bool BeginCreate( sal_uInt16 /*SdrObjKind ?*/ eSdrObjectKind, const Point &rPos );
sal_Bool BeginCreate( sal_uInt16 /*SdrObjKind ?*/ eSdrObjectKind, sal_uInt32 eObjInventor, const Point &);
void MoveCreate ( const Point &rPos );
@@ -490,32 +489,32 @@ public:
sal_Bool IsDrawCreate() const;
void CreateDefaultShape( sal_uInt16 /*SdrObjKind ?*/ eSdrObjectKind, const Rectangle& rRect, sal_uInt16 nSlotId);
- // Functions for Rubberbox, ti select Draw-Objects
+ /// Functions for Rubberbox, ti select Draw-Objects
sal_Bool BeginMark( const Point &rPos );
void MoveMark ( const Point &rPos );
sal_Bool EndMark ();
void BreakMark();
- // Create and destroy group, don't when frame is selected.
- sal_Bool IsGroupSelected(); // Can be a mixed selection!
- void GroupSelection(); // Afterwards the group is selected.
- void UnGroupSelection(); // The individual objects are selected, but
- // it is possible that there are groups included.
+ /// Create and destroy group, don't when frame is selected.
+ sal_Bool IsGroupSelected(); ///< Can be a mixed selection!
+ void GroupSelection(); ///< Afterwards the group is selected.
+ void UnGroupSelection(); /**< The individual objects are selected, but
... etc. - the rest is truncated
More information about the Libreoffice-commits
mailing list