diff options
author | Abdulmajeed Al-Abaulrazzaq <aalabdulrazzaq@kacst.edu.sa> | 2012-09-02 09:05:03 +0300 |
---|---|---|
committer | Norbert Thiebaud <nthiebaud@gmail.com> | 2012-09-02 08:01:03 +0000 |
commit | fc971580c76db8b7c9053883fef029fe1a243e21 (patch) | |
tree | 5d70945662a1ce814d3961b3d4b30b7e5483de3a /sw/inc/fesh.hxx | |
parent | 90d0127666b4d266a6ba151c0603ffe66f1f3a91 (diff) |
Modifying comments to meet doxygen standards
Change-Id: I4c82b7e543ec74cec3d4eb2985a3e4ec68c16b11
Change-Id: Iaf83b7119767cf0b953cab62d5555141e8e154bb
Reviewed-on: https://gerrit.libreoffice.org/496
Reviewed-by: Norbert Thiebaud <nthiebaud@gmail.com>
Tested-by: Norbert Thiebaud <nthiebaud@gmail.com>
Diffstat (limited to 'sw/inc/fesh.hxx')
-rw-r--r-- | sw/inc/fesh.hxx | 329 |
1 files changed, 164 insertions, 165 deletions
diff --git a/sw/inc/fesh.hxx b/sw/inc/fesh.hxx index 058f9127fac7..17f465598428 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 + it is possible that there are groups included. */ bool IsGroupAllowed() const; - void MirrorSelection( sal_Bool bHorizontal ); //Vertical if FALSE. + void MirrorSelection( sal_Bool bHorizontal ); ///< Vertical if FALSE. - // frmatr.hxx. Here no enum because of dependencies. - // bool value only for internal use! Anchor is newly set according - // to current document position. Anchor is not re-set. + /** frmatr.hxx. Here no enum because of dependencies. + bool value only for internal use! Anchor is newly set according + to current document position. Anchor is not re-set. */ void ChgAnchor( int eAnchorId, sal_Bool bSameOnly = sal_False, sal_Bool bPosCorr = sal_True ); sal_Bool SetDrawingAttr( SfxItemSet &rSet ); - // Get selected DrawObj as graphics (MetaFile/Bitmap). - // Return value indicates if it was converted. + /** Get selected DrawObj as graphics (MetaFile/Bitmap). + Return value indicates if it was converted. */ sal_Bool GetDrawObjGraphic( sal_uLong nFmt, Graphic& rGrf ) const; void Paste( SvStream& rStm, sal_uInt16 nAction, const Point* pPt = 0 ); @@ -532,7 +531,7 @@ public: const SfxItemSet* pGrfAttrSet = 0, SwFrmFmt* = 0 ); - // Insertion of a drawing object which have to be already inserted in the DrawModel. + /// Insertion of a drawing object which have to be already inserted in the DrawModel. void InsertDrawObj( SdrObject& rDrawObj, const Point& rInsertPosition ); @@ -540,26 +539,26 @@ public: const Graphic* pGrf = 0 ); // --> #i972# - // for starmath formulas anchored 'as char' it alignes it baseline to baseline - // changing the previous vertical orientation + /** for starmath formulas anchored 'as char' it alignes it baseline to baseline + changing the previous vertical orientation */ void AlignFormulaToBaseline( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj, SwFlyFrm * pFly = 0 ); - // aligns all formulas with anchor 'as char' to baseline + /// aligns all formulas with anchor 'as char' to baseline void AlignAllFormulasToBaseline(); - // Provide information about content situated closes to given Point. + /// Provide information about content situated closes to given Point. Point GetCntntPos( const Point& rPoint, sal_Bool bNext ) const; - // Convert document position into position relative to the current page. + /// Convert document position into position relative to the current page. Point GetRelativePagePosition(const Point& rDocPos); - // Hide or show layout-selection and pass call to CrsrSh. + /// Hide or show layout-selection and pass call to CrsrSh. void ShLooseFcs(); void ShGetFcs( sal_Bool bUpdate = sal_True ); - // PageDescriptor-interface + /// PageDescriptor-interface void ChgCurPageDesc( const SwPageDesc& ); sal_uInt16 GetCurPageDesc( const sal_Bool bCalcFrm = sal_True ) const; sal_uInt16 GetMousePageDesc( const Point &rPt ) const; @@ -570,8 +569,8 @@ public: const SwPageDesc& GetPageDesc( sal_uInt16 i ) const; void ChgPageDesc( sal_uInt16 i, const SwPageDesc& ); - // if inside all selection only one PageDesc, return this. - // Otherwise return 0 pointer + /** if inside all selection only one PageDesc, @return this. + Otherwise @return 0 pointer */ const SwPageDesc* GetSelectedPageDescs() const; const SwRect& GetAnyCurRect( CurRectType eType, @@ -580,7 +579,7 @@ public: ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >() ) const; - // Page number of the page containing Point, O if no page. + /// Page number of the page containing Point, O if no page. sal_uInt16 GetPageNumber( const Point &rPoint ) const; sal_Bool GetPageNumber( long nYPos, sal_Bool bAtCrsrPos, sal_uInt16& rPhyNum, sal_uInt16& rVirtNum, String &rDisplay ) const; @@ -588,14 +587,14 @@ public: const SfxItemSet* pFlyAttrSet = 0, const SfxItemSet* pGrfAttrSet = 0, SwFrmFmt* = 0 ); - sal_Bool FinishOLEObj(); //Shutdown server. + sal_Bool FinishOLEObj(); ///< Shutdown server. void GetTblAttr( SfxItemSet & ) const; void SetTblAttr( const SfxItemSet & ); sal_Bool HasWholeTabSelection() const; - // Is content of a table cell or at least a table cell completely selected? + /// Is content of a table cell or at least a table cell completely selected? sal_Bool HasBoxSelection() const; sal_Bool InsertRow( sal_uInt16 nCnt, sal_Bool bBehind ); @@ -603,27 +602,27 @@ public: sal_Bool DeleteCol(); sal_Bool DeleteRow(); - sal_Bool DeleteTblSel(); // Current selection, may be whole table. + sal_Bool DeleteTblSel(); ///< Current selection, may be whole table. - sal_uInt16 MergeTab(); // Merge selected parts of table. - // Return error via enum. + sal_uInt16 MergeTab(); /**< Merge selected parts of table. + @return error via enum. */ - // Split cell vertically or horizontally. + /// Split cell vertically or horizontally. sal_Bool SplitTab( sal_Bool nVert = sal_True, sal_uInt16 nCnt = 1, sal_Bool bSameHeight = sal_False ); sal_Bool Sort(const SwSortOptions&); //Sortieren. void SetRowHeight( const SwFmtFrmSize &rSz ); - // Pointer must be detroyed by caller != 0. + /// Pointer must be detroyed by caller != 0. void GetRowHeight( SwFmtFrmSize *&rpSz ) const; void SetRowSplit( const SwFmtRowSplit &rSz ); void GetRowSplit( SwFmtRowSplit *&rpSz ) const; void SetBoxAlign( sal_uInt16 nOrient ); - sal_uInt16 GetBoxAlign() const; // USHRT_MAX if ambiguous. + sal_uInt16 GetBoxAlign() const; ///< USHRT_MAX if ambiguous. - // Adjustment of Rowheights. Determine via bTstOnly if more than one row is selected. + /// Adjustment of Rowheights. Determine via bTstOnly if more than one row is selected. sal_Bool BalanceRowHeight( sal_Bool bTstOnly ); void SetTabBorders( const SfxItemSet& rSet ); @@ -634,22 +633,22 @@ public: void GetTabBackground( SvxBrushItem &rToFill ) const; void SetBoxBackground( const SvxBrushItem &rNew ); - sal_Bool GetBoxBackground( SvxBrushItem &rToFill ) const; //FALSE ambiguous. + sal_Bool GetBoxBackground( SvxBrushItem &rToFill ) const; ///< FALSE ambiguous. void SetBoxDirection( const SvxFrameDirectionItem& rNew ); - sal_Bool GetBoxDirection( SvxFrameDirectionItem& rToFill ) const; //FALSE ambiguous. + sal_Bool GetBoxDirection( SvxFrameDirectionItem& rToFill ) const; ///< FALSE ambiguous. void SetRowBackground( const SvxBrushItem &rNew ); - sal_Bool GetRowBackground( SvxBrushItem &rToFill ) const; //FALSE ambiguous. + sal_Bool GetRowBackground( SvxBrushItem &rToFill ) const; ///< FALSE ambiguous. sal_uInt8 WhichMouseTabCol( const Point &rPt ) const; - void GetTabCols( SwTabCols &rToFill ) const; // Info about columns and margins. + void GetTabCols( SwTabCols &rToFill ) const; ///< Info about columns and margins. void SetTabCols( const SwTabCols &rNew, sal_Bool bCurRowOnly = sal_True ); void GetMouseTabCols( SwTabCols &rToFill, const Point &rPt ) const; void SetMouseTabCols( const SwTabCols &rNew, sal_Bool bCurRowOnly, const Point &rPt ); - // pEnd will be used during MouseMove + /// pEnd will be used during MouseMove bool SelTblRowCol( const Point& rPt, const Point* pEnd = 0, bool bRowDrag = false ); void GetTabRows( SwTabCols &rToFill ) const; @@ -657,10 +656,10 @@ public: void GetMouseTabRows( SwTabCols &rToFill, const Point &rPt ) const; void SetMouseTabRows( const SwTabCols &rNew, sal_Bool bCurColOnly, const Point &rPt ); - void ProtectCells(); // If a table selection exists it is destroyed in case - // cursor is not allowed in readonly. - void UnProtectCells(); // Refers to table selection. - void UnProtectTbls(); // Unprotect all tables in selection. + void ProtectCells(); /**< If a table selection exists it is destroyed in case + cursor is not allowed in readonly. */ + void UnProtectCells(); ///< Refers to table selection. + void UnProtectTbls(); ///< Unprotect all tables in selection. sal_Bool HasTblAnyProtection( const String* pTblName = 0, sal_Bool* pFullTblProtection = 0 ); sal_Bool CanUnProtectCells() const; @@ -669,25 +668,25 @@ public: void SetRowsToRepeat( sal_uInt16 nNumOfRows ); sal_uInt16 GetVirtPageNum( const sal_Bool bCalcFrm = sal_True ); - //Returns the number of table rows currently selected - //if the selection start at the top of the table. + /** @return the number of table rows currently selected + if the selection start at the top of the table. */ sal_uInt16 GetRowSelectionFromTop() const; sal_Bool IsInRepeatedHeadline() const { return CheckHeadline( true ); } sal_Bool IsInHeadline() const { return CheckHeadline( false ); } - // Adjusts cell widths in such a way, that their content - // does not need to be wrapped (if possible). - // bBalance provides for adjustment of selected columns. + /** Adjusts cell widths in such a way, that their content + does not need to be wrapped (if possible). + bBalance provides for adjustment of selected columns. */ void AdjustCellWidth( sal_Bool bBalance = sal_False ); - // Not allowed if only empty cells are selected. + /// Not allowed if only empty cells are selected. sal_Bool IsAdjustCellWidthAllowed( sal_Bool bBalance = sal_False ) const; - // Adjustment of cell-widths; determine via bTstOnly if more than one cell is selected. + /// Adjustment of cell-widths; determine via bTstOnly if more than one cell is selected. sal_Bool BalanceCellWidth( sal_Bool bTstOnly ); - // AutoFormat for table/ table selection. + /// AutoFormat for table/ table selection. sal_Bool SetTableAutoFmt( const SwTableAutoFmt& rNew ); sal_Bool GetTableAutoFmt( SwTableAutoFmt& rGet ); @@ -696,13 +695,13 @@ public: sal_Bool GetAutoSum( String& rFml ) const; - // Phy: real page count. - // Virt: consider offset that may have been set by user. + /** Phy: real page count. + Virt: consider offset that may have been set by user. */ sal_uInt16 GetPhyPageNum(); void SetNewPageOffset( sal_uInt16 nOffset ); - void SetPageOffset( sal_uInt16 nOffset ); //Changes last page offset. - sal_uInt16 GetPageOffset() const; //Returns last page offset. + void SetPageOffset( sal_uInt16 nOffset ); ///< Changes last page offset. + sal_uInt16 GetPageOffset() const; ///< @return last page offset. void InsertLabel( const SwLabelType eType, const String &rTxt, const String& rSeparator, const String& rNumberSeparator, @@ -710,13 +709,13 @@ public: const String& rCharacterStyle, const sal_Bool bCpyBrd = sal_True ); - // The ruler needs some information too. + /// The ruler needs some information too. sal_uInt16 GetCurColNum( SwGetCurColNumPara* pPara = 0 ) const; //0 == not in any column. sal_uInt16 GetCurMouseColNum( const Point &rPt, SwGetCurColNumPara* pPara = 0 ) const; sal_uInt16 GetCurTabColNum() const; //0 == not in any table. sal_uInt16 GetCurMouseTabColNum( const Point &rPt ) const; - sal_uInt16 GetCurOutColNum( SwGetCurColNumPara* pPara = 0 ) const; // Current outer column. + sal_uInt16 GetCurOutColNum( SwGetCurColNumPara* pPara = 0 ) const; ///< Current outer column. sal_Bool IsTableRightToLeft() const; sal_Bool IsMouseTableRightToLeft( const Point &rPt ) const; @@ -724,7 +723,7 @@ public: sal_Bool IsLastCellInRow() const; - // Width of current range for column-dialog. + /// Width of current range for column-dialog. long GetSectionWidth( SwFmt& rFmt ) const; void GetConnectableFrmFmts |