diff options
author | Philipp Riemer <ruderphilipp@gmail.com> | 2012-06-02 19:41:10 +0200 |
---|---|---|
committer | Norbert Thiebaud <nthiebaud@gmail.com> | 2012-06-03 00:58:59 -0500 |
commit | 510f70015aba59d5bb4cc2ab9667c08676c37a78 (patch) | |
tree | 23e3f576df012edfe82d2adb24c50829145b437f /sw | |
parent | 9b43bf2ce3b947b494e076cad853d09a6e6d7544 (diff) |
translate German comments in sw/source/core/inc/f*.hxx
Diffstat (limited to 'sw')
-rw-r--r-- | sw/source/core/inc/flyfrms.hxx | 34 | ||||
-rw-r--r-- | sw/source/core/inc/fntcache.hxx | 2 | ||||
-rw-r--r-- | sw/source/core/inc/frame.hxx | 197 | ||||
-rw-r--r-- | sw/source/core/inc/frminf.hxx | 26 | ||||
-rw-r--r-- | sw/source/core/inc/frmtool.hxx | 103 | ||||
-rw-r--r-- | sw/source/core/inc/ftnboss.hxx | 35 | ||||
-rw-r--r-- | sw/source/core/inc/ftnfrm.hxx | 30 |
7 files changed, 200 insertions, 227 deletions
diff --git a/sw/source/core/inc/flyfrms.hxx b/sw/source/core/inc/flyfrms.hxx index e774f8b79d84..0f2cfbed86ea 100644 --- a/sw/source/core/inc/flyfrms.hxx +++ b/sw/source/core/inc/flyfrms.hxx @@ -31,19 +31,18 @@ // #i28701# class SwFlyAtCntFrm; -//Basisklasse fuer diejenigen Flys, die sich relativ frei Bewegen koennen - -//also die nicht _im_ Inhalt gebundenen Flys. +// Base class for those Flys that can "move freely" or better that are not +// bound in Cntnt. class SwFlyFreeFrm : public SwFlyFrm { - SwPageFrm *pPage; //Bei dieser Seite ist der Fly angemeldet. + SwPageFrm *pPage; // page where the Fly is registered // #i34753# - flag for at-page anchored Writer fly frames // to prevent a positioning - call of method <MakeObjPos()> -, if Writer // fly frame is already clipped during its format by the object formatter. bool mbNoMakePos; - // #i37068# - flag to prevent move in method - // <CheckClip(..)> + // #i37068# - flag to prevent move in method <CheckClip(..)> bool mbNoMoveOnCheckClip; void CheckClip( const SwFmtFrmSize &rSz ); //'Emergency' Clipping. @@ -119,8 +118,7 @@ public: virtual bool IsFormatPossible() const; }; - -//Die Fly's, die an einem Layoutfrm haengen und nicht inhaltsgebunden sind +// Flys that are bound to LayoutFrms and not to Cntnt class SwFlyLayFrm : public SwFlyFreeFrm { public: @@ -133,7 +131,7 @@ protected: virtual void Modify( const SfxPoolItem*, const SfxPoolItem* ); }; -//Die Flys, die an einem Cntnt haengen nicht aber im Inhalt +// Flys that are bound to Cntnt but not in Cntnt class SwFlyAtCntFrm : public SwFlyFreeFrm { protected: @@ -171,7 +169,7 @@ public: virtual bool IsFormatPossible() const; }; -//Die Flys, die an einem Zeichen in einem Cntnt haengen. +// Flys that are bound to a character in Cntnt class SwFlyInCntFrm : public SwFlyFrm { Point aRef; //Relativ zu diesem Point wird die AbsPos berechnet. @@ -209,23 +207,21 @@ public: sal_Bool IsInvalidLayout() const { return bInvalidLayout; } sal_Bool IsInvalidCntnt() const { return bInvalidCntnt; } - - //BP 26.11.93: vgl. tabfrm.hxx, gilt bestimmt aber fuer andere auch... - //Zum Anmelden der Flys nachdem ein FlyCnt erzeugt _und_ eingefuegt wurde. - //Muss vom Erzeuger gerufen werden, denn erst nach dem Konstruieren wird - //Das Teil gepastet; mithin ist auch erst dann die Seite zum Anmelden der - //Flys erreichbar. + // (26.11.93, see tabfrm.hxx, but might also be valid for others) + // For creation of a Fly after a FlyCnt was created _and_ inserted. + // Must be called by creator because can be pasted only after creation. + // Sometimes the page for registering the Flys is not visible until then + // as well. void RegistFlys(); - //siehe layact.cxx + //see layact.cxx void AddRefOfst( long nOfst ) { aRef.Y() += nOfst; } // #i26791# virtual void MakeObjPos(); - // invalidate anchor frame on invalidation - // of the position, because the position is calculated during the - // format of the anchor frame + // invalidate anchor frame on invalidation of the position, because the + // position is calculated during the format of the anchor frame virtual void _ActionOnInvalidation( const InvalidationType _nInvalid ); }; diff --git a/sw/source/core/inc/fntcache.hxx b/sw/source/core/inc/fntcache.hxx index 7087b0626335..3346321aa93c 100644 --- a/sw/source/core/inc/fntcache.hxx +++ b/sw/source/core/inc/fntcache.hxx @@ -63,7 +63,7 @@ public: void Flush(); }; -// Font-Cache, globale Variable, in txtinit.Cxx angelegt/zerstoert +// Font cache, global variable, created/destroyed in txtinit.cxx extern SwFntCache *pFntCache; extern SwFntObj *pLastFont; extern sal_uInt8 *pMagicNo; diff --git a/sw/source/core/inc/frame.hxx b/sw/source/core/inc/frame.hxx index a0c620ccf847..a13013f75d13 100644 --- a/sw/source/core/inc/frame.hxx +++ b/sw/source/core/inc/frame.hxx @@ -33,9 +33,9 @@ #include <drawinglayer/processor2d/baseprocessor2d.hxx> #include <svl/svarray.hxx> #include <editeng/borderline.hxx> -#include "swtypes.hxx" // fuer SwTwips +#include "swtypes.hxx" #include "swrect.hxx" -#include "calbck.hxx" // fuer SwClient +#include "calbck.hxx" #include <svl/brdcst.hxx> #include "IDocumentDrawModelAccess.hxx" @@ -67,12 +67,11 @@ class SwSortedObjs; class SwAnchoredObject; typedef struct _xmlTextWriter *xmlTextWriterPtr; -//Jeder FrmTyp findet sich hier in einem Bit wieder. -//Die Bits muessen so gesetzt werden, dass mit einer Maskierung festgestellt -//werden kann was fuer ein FrmTyp eine Instanz ist _und_ von welchen Klassen -//sie abgeleitet ist. -//Der Frm hat in der Basisklasse einen Member der von den CToren der -//einzelnen Frms entsprechend gesetzt werden muss. +// Each FrmType is represented here as a bit. +// The bits must be set in a way that it can be determined with masking of +// which kind of FrmType an instance is _and_ from what classes it was derived. +// Each frame has in its base class a member that must be set by the +// constructors accordingly. #define FRM_ROOT 0x0001 #define FRM_PAGE 0x0002 #define FRM_COLUMN 0x0004 @@ -90,7 +89,7 @@ typedef struct _xmlTextWriter *xmlTextWriterPtr; #define FRM_TXT 0x4000 #define FRM_NOTXT 0x8000 -//Fuer den internen Gebrauch ein paar gebraeuchliche Verknuepfungen. +// for internal use some common combinations #define FRM_LAYOUT 0x3FFF #define FRM_CNTNT 0xC000 #define FRM_FTNBOSS 0x0006 @@ -237,13 +236,13 @@ extern SwRectFn fnRectHori, fnRectVert, fnRectB2T, fnRectVL2R, fnRectVertL2R; ( (aFrm1.*fnRect->fnGetTop)() != (aFrm2.*fnRect->fnGetTop)() || \ (aFrm1.*fnRect->fnGetLeft)() != (aFrm2.*fnRect->fnGetLeft)() ) -//Fuer GetNextLeaf/GetPrevLeaf. +// for GetNextLeaf/GetPrevLeaf. enum MakePageType { - MAKEPAGE_NONE, //Keine Seite bzw. Fussnote anlegen - MAKEPAGE_APPEND, //Nur ggf. Seite anhaengen - MAKEPAGE_INSERT, //Seite ggf. anhaengen oder einfuegen. - MAKEPAGE_FTN, //Fussnote ggf. einfuegen. + MAKEPAGE_NONE, // do not create page/footnote + MAKEPAGE_APPEND, // only append page if needed + MAKEPAGE_INSERT, // add or append page if needed + MAKEPAGE_FTN, // add footnote if needed MAKEPAGE_NOSECTION // Don't create section frames }; @@ -257,30 +256,30 @@ enum MakePageType */ class SwFrm: public SwClient, public SfxBroadcaster { - //Der verkappte Frm + // the hidden Frm friend class SwFlowFrm; - friend class SwLayoutFrm; // Sw3FrameIo: fuer pNext, pPrev - friend class SwLooping; // LoopControlling (layouter.cxx) + friend class SwLayoutFrm; + friend class SwLooping; - //Hebt die Lower waehrend eines Spaltenumbaus auf. + // voids lower during creation of a column friend SwFrm *SaveCntnt( SwLayoutFrm *, SwFrm* pStart = NULL ); friend void RestoreCntnt( SwFrm *, SwLayoutFrm *, SwFrm *pSibling, bool bGrow ); #ifdef DBG_UTIL - //removes empty SwSectionFrms from a chain + // remove empty SwSectionFrms from a chain friend SwFrm* SwClearDummies( SwFrm* pFrm ); #endif - //Zum validieren eines unsinnig invalidierten in SwCntntFrm::MakeAll + // for validating a mistakenly invalidated one in SwCntntFrm::MakeAll friend void ValidateSz( SwFrm *pFrm ); - // Implementiert in text/txtftn.cxx, verhindert Ftn-Oszillation + // implemented in text/txtftn.cxx, prevents Ftn oscillation friend void ValidateTxt( SwFrm *pFrm ); // friend void CalcAnchorAndKeep( SwFlyFrm * ); friend void MakeNxt( SwFrm *pFrm, SwFrm *pNxt ); - //Cache fuer (Umrandungs-)Attribute. + // cache for (border) attributes static SwCache *pCache; // #i65250# @@ -362,10 +361,10 @@ class SwFrm: public SwClient, public SfxBroadcaster const SwLayoutFrm* ImplGetNextLayoutLeaf( bool bFwd ) const; protected: - SwSortedObjs* pDrawObjs; //Hier haengen die DrawObjs, kann 0 sein + SwSortedObjs* pDrawObjs; // draw objects, can be 0 - SwRect aFrm; //Absolute Dokumentposition und groesse des Frm - SwRect aPrt; //Position der PrtArea rel zum Frm und groesse der PrtArea + SwRect aFrm; // absolute position in document and size of the Frm + SwRect aPrt; // position relatively to Frm and size of PrtArea sal_uInt16 bReverse: 1; // Next line above/at the right side instead // under/at the left side of the previous line. @@ -385,23 +384,22 @@ protected: sal_Bool bValidLineNum: 1; sal_Bool bFixSize: 1; sal_Bool bUnUsed1: 1; - sal_Bool bCompletePaint: 1; //Frame wird ganz gepaintet wenn sal_True, auch - //wenn der Inhalt nur teilw. veraendert ist; - //Bei CntntFrms wird ausschliesslich wenn sal_True - //der Border (von Action) gemalt. - sal_Bool bRetouche: 1; //Der Frame ist fuer Retusche verantwortlich - //wenn sal_True. + // if sal_True, frame will be painted completely even content was changed + // only partially. For CntntFrms a border (from Action) will exclusively + // painted if <bCompletePaint> is sal_True. + sal_Bool bCompletePaint : 1; + sal_Bool bRetouche : 1; // frame is responsible for retouching public: sal_Bool bUnUsed2: 1; protected: - sal_Bool bInfInvalid: 1; //InfoFlags sind Invalid. - sal_Bool bInfBody: 1; //Frm steht im DokumentBody. - sal_Bool bInfTab: 1; //Frm steht in einer Tabelle. - sal_Bool bInfFly: 1; //Frm steht in einem Fly. - sal_Bool bInfFtn: 1; //Frm steht in einer Fussnote. - sal_Bool bInfSct: 1; //Frm steht in einem Bereich. - sal_Bool bColLocked: 1; //Grow/Shrink sperren bei spaltigen Section- - //oder Fly-Frames, wird im Format gesetzt + sal_Bool bInfInvalid : 1; // InfoFlags are invalid + sal_Bool bInfBody : 1; // Frm is in document body + sal_Bool bInfTab : 1; // Frm is in a table + sal_Bool bInfFly : 1; // Frm is in a Fly + sal_Bool bInfFtn : 1; // Frm is in a footnote + sal_Bool bInfSct : 1; // Frm is in a section + sal_Bool bColLocked : 1; // lock Grow/Shrink for column-wise section + // or fly frames, will be set in Format void ColLock() { bColLocked = sal_True; } void ColUnlock() { bColLocked = sal_False; } @@ -415,16 +413,16 @@ protected: void PrepareMake(); void OptPrepareMake(); void MakePos(); - // method formats next frame of table frame to assure keep attribute. - // in case of nested tables method <SwFrm::MakeAll()> is called to - // avoid format of superior table frame. + // Format next frame of table frame to assure keeping attributes. + // In case of nested tables method <SwFrm::MakeAll()> is called to + // avoid formating of superior table frame. friend SwFrm* lcl_FormatNextCntntForKeep( SwTabFrm* pTabFrm ); virtual void MakeAll() = 0; - //Adjustierung der Frames einer Seite + // adjust frames of a page SwTwips AdjustNeighbourhood( SwTwips nDiff, sal_Bool bTst = sal_False ); - //Aendern nur die Framesize, nicht die PrtArea-SSize + // change only frame size not the size of PrtArea virtual SwTwips ShrinkFrm( SwTwips, sal_Bool bTst = sal_False, sal_Bool bInfo = sal_False ) = 0; virtual SwTwips GrowFrm ( SwTwips, sal_Bool bTst = sal_False, sal_Bool bInfo = sal_False ) = 0; @@ -456,14 +454,14 @@ protected: */ virtual void _ActionOnInvalidation( const InvalidationType _nInvalid ); - //Schatten und Umrandung painten + // draw shadow and borders void PaintShadow( const SwRect&, SwRect&, const SwBorderAttrs& ) const; virtual void Modify( const SfxPoolItem*, const SfxPoolItem* ); virtual const IDocumentDrawModelAccess* getIDocumentDrawModelAccess( ); public: - TYPEINFO(); //Bereits in Basisklasse Client drin. + TYPEINFO(); // already in base class sal_uInt16 GetType() const { return 0x1 << nType; } @@ -471,25 +469,24 @@ public: static SwCache *GetCachePtr() { return pCache; } static void SetCache( SwCache *pNew ) { pCache = pNew; } - //Aendern die PrtArea-SSize und die FrmSize. + // change PrtArea size and FrmSize SwTwips Shrink( SwTwips, sal_Bool bTst = sal_False, sal_Bool bInfo = sal_False ); SwTwips Grow ( SwTwips, sal_Bool bTst = sal_False, sal_Bool bInfo = sal_False ); - //Wir brauchen unterschiedliche Methoden (wg. Performance) fuer das - //Einfuegenin den Layout Baum: + // different methods for inserting in layout tree (for performance reasons) - //Einfuegen vor pBehind oder am Ende der Kette unter pUpper + // insert before pBehind or at the end of the chain below pUpper void InsertBefore( SwLayoutFrm* pParent, SwFrm* pBehind ); - //Einfuegen hinter pBefore oder am Anfang der Kette unter pUpper + // insert after pBefore or at the beginnig of the chain below pUpper void InsertBehind( SwLayoutFrm *pParent, SwFrm *pBefore ); - //Einfuegen vor pBehind oder am Ende der Kette, unter Beruecksichtigung - //der Geschwister von pSct + // insert before pBehind or at the end of the chain while considering + // the siblings of pSct void InsertGroupBefore( SwFrm* pParent, SwFrm* pWhere, SwFrm* pSct ); void Remove(); - //For internal use only; wer es anders macht wird - //in einen Sack gesteckt und muss zwei Tage drin hocken bleiben. - //Fuert Spezialbehandlung fuer _Get[Next|Prev]Leaf() durch (Tabellen). + // For internal use only - who ignores this will be put in a sack and has + // to stay there for two days + // Does special treatment for _Get[Next|Prev]Leaf() (for tables). SwLayoutFrm *GetLeaf( MakePageType eMakePage, sal_Bool bFwd ); SwLayoutFrm *GetNextLeaf ( MakePageType eMakePage ); SwLayoutFrm *GetNextFtnLeaf( MakePageType eMakePage ); @@ -508,7 +505,7 @@ public: void AppendDrawObj( SwAnchoredObject& _rNewObj ); void RemoveDrawObj( SwAnchoredObject& _rToRemoveObj ); - //Arbeiten mit der Kette der FlyFrms + // work with chain of FlyFrms void AppendFly( SwFlyFrm *pNew ); void RemoveFly( SwFlyFrm *pToRemove ); const SwSortedObjs *GetDrawObjs() const { return pDrawObjs; } @@ -531,7 +528,8 @@ public: drawinglayer::processor2d::BaseProcessor2D * CreateProcessor2D( ) const; void ProcessPrimitives( const drawinglayer::primitive2d::Primitive2DSequence& rSequence ) const; - //Retouche, nicht im Bereich des uebergebenen Rect! +// FIXME: EasyHack (refactoring): rename method name in all files + // retouch, not in the area of the given Rect! void Retouche( const SwPageFrm *pPage, const SwRect &rRect ) const; sal_Bool GetBackgroundBrush( const SvxBrushItem*& rpBrush, @@ -547,10 +545,10 @@ public: inline void ResetRetouche() const; inline sal_Bool IsRetouche() const { return bRetouche; } - void SetInfFlags(); //Setzen der InfoFlags + void SetInfFlags(); inline void InvalidateInfFlags() { bInfInvalid = sal_True; } - inline sal_Bool IsInDocBody() const; //Benutzen die InfoFlags. - inline sal_Bool IsInFtn() const; //ggf. werden die Flags ermittelt. + inline sal_Bool IsInDocBody() const; // use InfoFlags, determine flags + inline sal_Bool IsInFtn() const; // if necessary inline sal_Bool IsInTab() const; inline sal_Bool IsInFly() const; inline sal_Bool IsInSct() const; @@ -603,8 +601,8 @@ public: // sal_Bool IsMoveable() const; bool IsMoveable( const SwLayoutFrm* _pLayoutFrm = 0L ) const; - //Ist es fuer den (Txt)Frm in der aktuellen Umgebung erlaubt eine - //Fussnote einzufuegen (nicht z.B. in wiederholten TabellenHeadlines). + // Is it permitted for the (Txt)Frm to add a footnote in the current + // environment (not e.g. for repeating table headlines)? sal_Bool IsFtnAllowed() const; virtual void Format( const SwBorderAttrs *pAttrs = 0 ); @@ -618,10 +616,10 @@ public: inline sal_Bool HasFixSize() const { return bFixSize; } inline void SetFixSize( sal_Bool bNew ) { bFixSize = bNew; } - //Prueft alle Seiten ab der Uebergebenen und korrigiert ggf. + // check all pages (starting from the given) and correct them if needed static void CheckPageDescs( SwPageFrm *pStart, sal_Bool bNotifyFields = sal_True ); - //Koennen 0 liefern, einmal const einmal nicht + // might return 0, with and without const SwFrm *GetNext() { return pNext; } SwFrm *GetPrev() { return pPrev; } SwLayoutFrm *GetUpper() { return pUpper; } @@ -693,8 +691,8 @@ public: { return ( pNext || !IsInSct() ) ? pNext : _GetIndNext(); } const SwFrm* GetIndNext() const { return ((SwFrm*)this)->GetIndNext(); } - sal_uInt16 GetPhyPageNum() const; //Seitennummer ohne Offset - sal_uInt16 GetVirtPageNum() const; //Seitenummer mit Offset + sal_uInt16 GetPhyPageNum() const; // page number without offset + sal_uInt16 GetVirtPageNum() const; // page number with offset sal_Bool OnRightPage() const { return 0 != GetPhyPageNum() % 2; }; sal_Bool WannaRightPage() const; @@ -703,25 +701,25 @@ public: inline SwLayoutFrm *GetPrevLayoutLeaf(); inline SwLayoutFrm *GetNextLayoutLeaf(); - inline void Calc() const; //Hier wird ggf. 'Formatiert' - inline void OptCalc() const; //Hier wird zur Optimierung davon ausgegangen, - //das die Vorgaenger bereits formatiert sind. + inline void Calc() const; // here might be "formatted" + inline void OptCalc() const; // here we assume (for optimization) that + // the predecessors are already formatted inline Point GetRelPos() const; const SwRect &Frm() const { return aFrm; } const SwRect &Prt() const { return aPrt; } - // The PaintArea is the area, where content may be displayed. - // The margin of the page or the space between columns belongs to her. + // PaintArea is the area where content might be displayed. + // The margin of a page or the space between columns belongs to it. const SwRect PaintArea() const; - // The UnionFrm is the union of frm- and prt-area, normally identical - // to the frm-area except the case of negative prt-margins. + // UnionFrm is the union of Frm- and PrtArea, normally identical + // to the FrmArea except in case of negative Prt margins. const SwRect UnionFrm( sal_Bool bBorder = sal_False ) const; - //Der Zugriff auf die Member wird hier ausnahmsweiste gestattet, - //dies soll aber nicht dazu dienen die Werte wahllos zu veraendern; - //es ist nur die einzige Moeglichkeit die Compilerprobleme zu umgehen - //(gleiche Methode mal public mal protected). + // HACK: Here we exceptionally allow direct access to members. + // This should not delude into changing those value randomly; it is the + // only option to circumvent compiler problems (same method with public + // and protected). SwRect &Frm() { return aFrm; } SwRect &Prt() { return aPrt; } @@ -738,7 +736,7 @@ public: sal_Bool GetValidLineNumFlag()const { return bValidLineNum; } sal_Bool IsValid() const { return bValidPos && bValidSize && bValidPrtArea; } - //Invalideren nur den Frm + // Only invalidate Frm // #i28701# - add call to method <_ActionOnInvalidation(..)> // for all invalidation methods. // #i28701# - use method <_InvalidationAllowed(..)> to @@ -786,7 +784,7 @@ public: _ActionOnInvalidation( INVALID_ALL ); } } - //Benachrichtigen gleich die Seite mit. + // also notify page at the same time inline void InvalidateSize(); inline void InvalidatePrt(); inline void InvalidatePos(); @@ -816,25 +814,25 @@ public: virtual void Paint( SwRect const&, SwPrintData const*const pPrintData = NULL ) const; - // der "kurze Dienstweg" zwischen den Frames und der Formatierung. - // Wer den void* falsch Casted ist selbst schuld! - // Auf jedenfall muss der void* auf 0 geprueft werden. + // HACK: shortcut between frame and formatting + // It's your own fault if you cast void* incorrectly! In any case check + // the void* for 0. virtual void Prepare( const PrepareHint ePrep = PREP_CLEAR, const void *pVoid = 0, sal_Bool bNotify = sal_True ); - //sal_True wenn's die richtige Klasse ist, sal_False sonst + // sal_True if it is the correct class, sal_False otherwise inline sal_Bool IsLayoutFrm() const; inline sal_Bool IsRootFrm() const; inline sal_Bool IsPageFrm() const; inline sal_Bool IsColumnFrm() const; - inline sal_Bool IsFtnBossFrm() const; // Fussnotenbosse sind PageFrms und ColumnFrms + inline sal_Bool IsFtnBossFrm() const; // footnote bosses might be PageFrms or ColumnFrms inline sal_Bool IsHeaderFrm() const; inline sal_Bool IsFooterFrm() const; inline sal_Bool IsFtnContFrm() const; inline sal_Bool IsFtnFrm() const; inline sal_Bool IsBodyFrm() const; - inline sal_Bool IsColBodyFrm() const; // in layfrm.hxx implementiert, BodyFrm unterhalb ColumnFrm - inline sal_Bool IsPageBodyFrm() const; // in layfrm.hxx implementiert, BodyFrm unterhalb PageFrm + inline sal_Bool IsColBodyFrm() const; // implemented in layfrm.hxx, BodyFrm above ColumnFrm + inline sal_Bool IsPageBodyFrm() const; // implemented in layfrm.hxx, BodyFrm above PageFrm inline sal_Bool IsFlyFrm() const; inline sal_Bool IsSctFrm() const; inline sal_Bool IsTabFrm() const; @@ -843,17 +841,18 @@ public: inline sal_Bool IsCntntFrm() const; inline sal_Bool IsTxtFrm() const; inline sal_Bool IsNoTxtFrm() const; - inline sal_Bool IsFlowFrm() const; //Frms deren PrtArea von den Nachbarn - //abhaengen und die halt im Inhaltsfluss - //stehen. - inline sal_Bool IsRetoucheFrm() const; //Frms die Retouchefaehig sind bzw. die - //u.U. hinter sich Retouchieren muessen. + // Frms where its PrtArea depends on their neighbors and that are + // positioned in the content flow + inline sal_Bool IsFlowFrm() const; + // Frms that are capable of retouching or that might need to retouch behind + // themselves + inline sal_Bool IsRetoucheFrm() const; inline sal_Bool IsAccessibleFrm() const; - void PrepareCrsr(); //Die CrsrShell darf. + void PrepareCrsr(); // CrsrShell is allowed to call this - //Ist der Frm (bzw. die Section in der er steht) geschuetzt? - //Auch Fly in Fly in ... und Fussnoten + // Is the Frm (or the section containing it) protected? Same for Fly in + // Fly in ... and footnotes sal_Bool IsProtected() const; sal_Bool IsColLocked() const { return bColLocked; } @@ -905,8 +904,7 @@ public: void ValidateThisAndAllLowers( const sal_uInt16 nStage ); public: - /** if writer is NULL, dumps the layout structure as XML in layout.xml - */ + // if writer is NULL, dumps the layout structure as XML in layout.xml virtual void dumpAsXml(xmlTextWriterPtr writer = NULL); virtual void dumpInfosAsXml(xmlTextWriterPtr writer); virtual void dumpAsXmlAttributes(xmlTextWriterPtr writer); @@ -1047,7 +1045,7 @@ inline void SwFrm::InvalidateNextPos( sal_Bool bNoFtn ) { if ( pNext && !pNext->IsSctFrm() ) pNext->InvalidatePos(); -#ifndef C30 // vielleicht geht es ja bei C40 ? +#ifndef C30 // maybe it works for C40? else ImplInvalidateNextPos( bNoFtn ); #else @@ -1070,8 +1068,7 @@ inline void SwFrm::OptCalc() const inline Point SwFrm::GetRelPos() const { Point aRet( aFrm.Pos() ); - //hier wird gecasted, weil die Klasse SwLayoutFrm nur vorward- - //declariert ist. + // here we cast since SwLayoutFrm is declared only as forwarded aRet -= ((SwFrm*)GetUpper())->Prt().Pos(); aRet -= ((SwFrm*)GetUpper())->Frm().Pos(); return aRet; diff --git a/sw/source/core/inc/frminf.hxx b/sw/source/core/inc/frminf.hxx index f05658c8ced7..555ab64c1826 100644 --- a/sw/source/core/inc/frminf.hxx +++ b/sw/source/core/inc/frminf.hxx @@ -30,10 +30,9 @@ #include "swtypes.hxx" -class SwTxtFrm; // SwTxtFrmInfo -class SwPaM; // SwTxtFrmInfo -class SwTxtCursor; // SwTxtFrmInfo - +class SwTxtFrm; +class SwPaM; +class SwTxtCursor; /************************************************************************* * class SwTxtFrmInfo @@ -43,39 +42,38 @@ class SwTxtFrmInfo { const SwTxtFrm *pFrm; - // Wo beginnt der Text (ohne whitespaces)? (Dokument global !!) + // Where does the text (w/o whitespaces) start (document is global!)? SwTwips GetLineStart( const SwTxtCursor &rLine ) const; public: inline SwTxtFrmInfo( const SwTxtFrm *pTxtFrm ) : pFrm(pTxtFrm) { } - // Passt der Absatz in eine Zeile? + // Does the paragraph fit into a single line? sal_Bool IsOneLine() const; - // Ist die Zeile zu X% gefuellt? + // Is the line filled to X%? sal_Bool IsFilled( const sal_uInt8 nPercent ) const; - // Wo beginnt der Text (ohne whitespaces)? (rel. im Frame !!) + // Where does the text (w/o whitespaces) start (rel. in frame)? SwTwips GetLineStart() const; - //returne die mittel Position des n. Charakters + // return center position of the next character SwTwips GetCharPos( xub_StrLen nChar, sal_Bool bCenter = sal_True ) const; - // Sammelt die whitespaces am Zeilenbeginn und -ende im Pam + // collect all whitespaces at the beginning and end of a line in Pam void GetSpaces( SwPaM &rPam, sal_Bool bWithLineBreak ) const; - // Ist an der ersten Textposition ein Bullet/Symbol etc? + // Is a bullet point/symbol/etc. at the first text position? sal_Bool IsBullet( xub_StrLen nTxtPos ) const; - // Ermittelt Erstzeileneinzug + // determine intentation for first line SwTwips GetFirstIndent() const; - // setze und erfrage den Frame; const SwTxtFrm* GetFrm() const { return pFrm; } SwTxtFrmInfo& SetFrm( const SwTxtFrm* pNew ) { pFrm = pNew; return *this; } - // liegt eine Gegenueberstellung vor? (returnt Pos im Frame) + // Is it a comparison? Returns position in frame. sal_uInt16 GetBigIndent( xub_StrLen& rFndPos, const SwTxtFrm *pNextFrm = 0 ) const; }; diff --git a/sw/source/core/inc/frmtool.hxx b/sw/source/core/inc/frmtool.hxx index 8e3a65209cea..5cef92a99804 100644 --- a/sw/source/core/inc/frmtool.hxx +++ b/sw/source/core/inc/frmtool.hxx @@ -50,14 +50,13 @@ class SwPageDesc; class SwTableBox; struct SwFindRowSpanCacheObj; -#define FAR_AWAY LONG_MAX - 20000 //Initale Position der Flys. -#define BROWSE_HEIGHT 56700L * 10L //10 Meter - +#define FAR_AWAY LONG_MAX - 20000 // initial position of a Fly +#define BROWSE_HEIGHT 56700L * 10L // 10 Meters #define GRFNUM_NO 0 #define GRFNUM_YES 1 #define GRFNUM_REPLACE 2 -//Painten des Hintergrunds. Mit Brush oder Graphic. +// draw background with brush or graphics // - add 6th parameter to indicate that method should // consider background transparency, saved in the color of the brush item void DrawGraphic( const SvxBrushItem *, OutputDevice *, @@ -72,45 +71,42 @@ void SwAlignRect( SwRect &rRect, const ViewShell *pSh ); // Created declaration here to avoid <extern> declarations void SwAlignGrfRect( SwRect *pGrfRect, const OutputDevice &rOut ); -//Fly besorgen, wenn keine List hineingereicht wird, wir die der aktuellen -//Shell benutzt. -//Implementierung in feshview.cxx +// get Fly, if no List is given use the current shell +// Implementation in feshview.cxx SwFlyFrm *GetFlyFromMarked( const SdrMarkList *pLst, ViewShell *pSh ); -//Nicht gleich die math.lib anziehen. sal_uLong SqRt( BigInt nX ); SwFrm *SaveCntnt( SwLayoutFrm *pLay, SwFrm *pStart ); void RestoreCntnt( SwFrm *pSav, SwLayoutFrm *pParent, SwFrm *pSibling, bool bGrow ); -//CntntNodes besorgen, CntntFrms erzeugen und in den LayFrm haengen. +// Get CntntNodes, create CntntFrms, and add them to LayFrm. void _InsertCnt( SwLayoutFrm *pLay, SwDoc *pDoc, sal_uLong nIndex, sal_Bool bPages = sal_False, sal_uLong nEndIndex = 0, SwFrm *pPrv = 0 ); -//Erzeugen der Frames fuer einen bestimmten Bereich, verwendet _InsertCnt +// Creation of frames for a specific section (uses _InsertCnt) void MakeFrms( SwDoc *pDoc, const SwNodeIndex &rSttIdx, const SwNodeIndex &rEndIdx ); -//Um z.B. fuer Tabelleheadlines das Erzeugen der Flys in _InsertCnt zu unterbinden. +// prevent creation of Flys in _InsertCnt, e.g. for table headlines extern sal_Bool bDontCreateObjects; -//Fuer FlyCnts, siehe SwFlyAtCntFrm::MakeAll() +// for FlyCnts, see SwFlyAtCntFrm::MakeAll() extern sal_Bool bSetCompletePaintOnInvalidate; -//Fuer Tabelleneinstellung per Tastatur. +// for table settings via keyboard long CalcRowRstHeight( SwLayoutFrm *pRow ); long CalcHeightWidthFlys( const SwFrm *pFrm ); -//Neue Seite einsetzen SwPageFrm *InsertNewPage( SwPageDesc &rDesc, SwFrm *pUpper, sal_Bool bOdd, sal_Bool bInsertEmpty, sal_Bool bFtn, SwFrm *pSibling ); -//Flys bei der Seite anmelden. +// connect Flys with page void RegistFlys( SwPageFrm*, const SwLayoutFrm* ); -//Benachrichtung des Fly Hintergrundes wenn Notwendig. +// notification of Fly's background if needed void Notify( SwFlyFrm *pFly, SwPageFrm *pOld, const SwRect &rOld, const SwRect* pOldRect = 0 ); @@ -130,13 +126,12 @@ sal_Bool IsFrmInSameKontext( const SwFrm *pInnerFrm, const SwFrm *pFrm ); const SwFrm * FindPage( const SwRect &rRect, const SwFrm *pPage ); -// wird von SwCntntNode::GetFrm und von SwFlyFrm::GetFrm -// gerufen +// used by SwCntntNode::GetFrm and SwFlyFrm::GetFrm SwFrm* GetFrmOfModify( const SwRootFrm* pLayout, SwModify const&, sal_uInt16 const nFrmType, const Point* = 0, const SwPosition *pPos = 0, const sal_Bool bCalcFrm = sal_False ); -//Sollen ExtraDaten (Reline-Strich, Zeilennummern) gepaintet werden? +// Should extra data (reline stroke, line numbers) be painted? sal_Bool IsExtraData( const SwDoc *pDoc ); // #i11760# - method declaration <CalcCntnt(..)> @@ -144,10 +139,8 @@ void CalcCntnt( SwLayoutFrm *pLay, bool bNoColl = false, bool bNoCalcFollow = false ); - -//Die Notify-Klassen merken sich im CTor die aktuellen Groessen und fuehren -//im DTor ggf. die notwendigen Benachrichtigungen durch. - +// Notify classes memorize the current sizes in their constructor and do +// the necessary notifications in their destructor if needed class SwFrmNotify { protected: @@ -231,15 +224,11 @@ public: } }; -//SwBorderAttrs kapselt die Berechnung fuer die Randattribute inclusive -//Umrandung. Die Attribute und die errechneten Werte werden gecached. -//Neu: Die gesammte Klasse wird gecached. - -//!!!Achtung: Wenn weitere Attribute gecached werden muss unbedingt die -//Methode Modify::Modify mitgepflegt werden!!! - -// - delete old method <SwBorderAttrs::CalcRight()> and -// the stuff that belongs to it. +// SwBorderAttrs encapsulates the calculation for margin attributes including +// border. The whole class is cached. +// +// WARNING! If more attributes should be cached also adjust the method +// Modify::Modify! class SwBorderAttrs : public SwCacheObj { const SwAttrSet &rAttrSet; @@ -248,13 +237,13 @@ class SwBorderAttrs : public SwCacheObj SvxLRSpaceItem rLR; const SvxBoxItem &rBox; const SvxShadowItem &rShadow; - const Size aFrmSize; //Die FrmSize + const Size aFrmSize; - sal_Bool bBorderDist :1; //Ist's ein Frm der auch ohne Linie - //einen Abstand haben kann? + // Is it a frame that can have a margin without a border? + sal_Bool bBorderDist : 1; - //Mit den Folgenden Bools werden die gecache'ten Werte fuer UNgueltig - //erklaert - bis sie einmal berechnet wurden. + // the following bool values set the cached values to INVALID - until they + // are calculated for the first time sal_Bool bTopLine :1; sal_Bool bBottomLine :1; sal_Bool bLeftLine :1; @@ -263,11 +252,11 @@ class SwBorderAttrs : public SwCacheObj sal_Bool bBottom :1; sal_Bool bLine :1; - sal_Bool bIsLine :1; //Umrandung an mind. einer Kante? + sal_Bool bIsLine : 1; // border on at least one side? - sal_Bool bCacheGetLine :1; //GetTopLine(), GetBottomLine() cachen? - sal_Bool bCachedGetTopLine :1; //GetTopLine() gecached? - sal_Bool bCachedGetBottomLine :1; //GetBottomLine() gecached? + sal_Bool bCacheGetLine : 1; // cache GetTopLine(), GetBottomLine()? + sal_Bool bCachedGetTopLine : 1; // is GetTopLine() cached? + sal_Bool bCachedGetBottomLine : 1; // is GetBottomLine() cached? // - booleans indicating, if values <bJoinedWithPrev> // and <bJoinedWithNext> are cached and valid. // Caching depends on value of <bCacheGetLine>. @@ -278,7 +267,7 @@ class SwBorderAttrs : public SwCacheObj sal_Bool bJoinedWithPrev :1; sal_Bool bJoinedWithNext :1; - //Die gecache'ten Werte, undefiniert bis sie einmal berechnet wurden. + // The cached values (un-defined until calculated for the first time) sal_uInt16 nTopLine, nBottomLine, nLeftLine, @@ -288,13 +277,13 @@ class SwBorderAttrs : public SwCacheObj nGetTopLine, nGetBottomLine; - //Nur die Lines + Shadow errechnen. + // only calculate lines and shadow void _CalcTopLine(); void _CalcBottomLine(); void _CalcLeftLine(); void _CalcRightLine(); - //Lines + Shadow + Abstaende + // lines + shadow + margin void _CalcTop(); void _CalcBottom(); @@ -321,8 +310,7 @@ class SwBorderAttrs : public SwCacheObj sal_Bool _JoinWithCmp( const SwFrm& _rCallerFrm, const SwFrm& _rCmpFrm ) const; - //Rechte und linke Linie sowie LRSpace gleich? - // - change name of 1st parameter - "rAttrs" -> "rCmpAttrs". + // Are the left and right line and the LRSpace equal? sal_Bool CmpLeftRight( const SwBorderAttrs &rCmpAttrs, const SwFrm *pCaller, const SwFrm *pCmp ) const; @@ -374,7 +362,8 @@ public: class SwBorderAttrAccess : public SwCacheAccess { - const SwFrm *pConstructor; //opt: Zur weitergabe an SwBorderAttrs + const SwFrm *pConstructor; //opt: for passing on to SwBorderAttrs + protected: virtual SwCacheObj *NewObj(); @@ -384,11 +373,9 @@ public: SwBorderAttrs *Get(); }; -//--------------------------------------------------------------------- -//Iterator fuer die DrawObjecte einer Seite. Die Objecte werden Nach ihrer -//Z-Order iteriert. -//Das iterieren ist nicht eben billig, denn fuer alle Operationen muss jeweils -//ueber das gesamte SortArray iteriert werden. +// Iterator for draw objects of a page. The objects will be iterated sorted by +// their Z-order. Iterating is not cheap since for each operation the _whole_ +// SortArray needs to be traversed. class SwOrderIter { const SwPageFrm *pPage; @@ -427,11 +414,9 @@ public: static sal_uInt8 Count() { return StackHack::nCnt; } }; - -//Sollen obere bzw. untere Umrandung fuer den Frm ausgewertet werden? -// #i25029# - add optional 2nd parameter <_pPrevFrm> -// If set, its value is taken for testing, if borders/shadow have to joined -// with previous frame. +// Should upper (or lower) border be evaluated for this frame? +// #i25029# - If <_pPrevFrm> is set, its value is taken for testing, if +// borders/shadow have to be joined with previous frame. inline sal_uInt16 SwBorderAttrs::GetTopLine ( const SwFrm& _rFrm, const SwFrm* _pPrevFrm ) const { @@ -541,8 +526,8 @@ const SwCntntFrm* GetCellCntnt( const SwLayoutFrm& rCell_ ); /** helper class to check if a frame has been deleted during an operation - * !!!WARNING!!! This should only be used as a last and desperate means - * to make the code robust. + * WARNING! This should only be used as a last and desperate means to make the + * code robust. */ class SwDeletionChecker diff --git a/sw/source/core/inc/ftnboss.hxx b/sw/source/core/inc/ftnboss.hxx index 21aab8886a39..def0decd23cd 100644 --- a/sw/source/core/inc/ftnboss.hxx +++ b/sw/source/core/inc/ftnboss.hxx @@ -35,9 +35,8 @@ class SwFtnContFrm; class SwFtnFrm; class SwTxtFtn; - -//Setzen des maximalen Fussnotenbereiches. Restaurieren des alten Wertes im DTor. -//Implementierung im ftnfrm.cxx +// Set max. footnote area. +// Restoration of the old value in DTor. Implementation in ftnfrm.cxx class SwSaveFtnHeight { SwFtnBossFrm *pBoss; @@ -55,12 +54,12 @@ public: class SwFtnBossFrm: public SwLayoutFrm { - //Fuer die privaten Fussnotenoperationen + // for private footnote operations friend class SwFrm; friend class SwSaveFtnHeight; - friend class SwPageFrm; // fuer das Setzen der MaxFtnHeight + friend class SwPageFrm; // for setting of MaxFtnHeight - //Maximale Hoehe des Fussnotencontainers fuer diese Seite. + // max. height of the footnote container on this page SwTwips nMaxFtnHeight; SwFtnContFrm *MakeFtnCont(); @@ -77,7 +76,7 @@ public: inline const SwLayoutFrm *FindBodyCont() const; inline void SetMaxFtnHeight( const SwTwips nNewMax ) { nMaxFtnHeight = nNewMax; } - //Fussnotenschnittstelle + // footnote interface void AppendFtn( SwCntntFrm *, SwTxtFtn * ); void RemoveFtn( const SwCntntFrm *, const SwTxtFtn *, sal_Bool bPrep = sal_True ); static SwFtnFrm *FindFtn( const SwCntntFrm *, const SwTxtFtn * ); @@ -91,21 +90,20 @@ public: void RearrangeFtns( const SwTwips nDeadLine, const sal_Bool bLock = sal_False, const SwTxtFtn *pAttr = 0 ); - //SS damit der Textformatierer Temporaer die Fussnotenhoehe begrenzen - //kann. DeadLine in Dokumentkoordinaten. + // Set DeadLine (in document coordinates) so that the text formatter can + // temporarily limit footnote height. void SetFtnDeadLine( const SwTwips nDeadLine ); SwTwips GetMaxFtnHeight() const { return nMaxFtnHeight; } - //Liefert den Wert, der noch uebrig ist, bis der Body seine minimale - //Hoehe erreicht hat. + // returns value for remaining space until the body reaches minimal height SwTwips GetVarSpace() const; - //Layoutseitig benoetigte Methoden - /// OD 03.04.2003 #108446# - add parameters <_bCollectOnlyPreviousFtns> and - /// <_pRefFtnBossFrm> in order to control, if only footnotes, which are positioned - /// before the given reference footnote boss frame have to be collected. - /// Note: if parameter <_bCollectOnlyPreviousFtns> is true, then parameter - /// <_pRefFtnBossFrm> have to be referenced to an object. + // methods needed for layouting + // The parameters <_bCollectOnlyPreviousFtns> and <_pRefFtnBossFrm> control + // if only footnotes that are positioned before the given reference + // footnote boss-frame have to be collected. + // Note: if parameter <_bCollectOnlyPreviousFtns> is true, then parameter + // <_pRefFtnBossFrm> has to be referenced by an object. static void _CollectFtns( const SwCntntFrm* _pRef, SwFtnFrm* _pFtn, SvPtrarr& _rFtnArr, @@ -121,7 +119,8 @@ public: void _MoveFtns( SvPtrarr &rFtnArr, sal_Bool bCalc = sal_False ); void MoveFtns( const SwCntntFrm *pSrc, SwCntntFrm *pDest, SwTxtFtn *pAttr ); - // Sollte AdjustNeighbourhood gerufen werden (oder Grow/Shrink)? + + // should AdjustNeighbourhood be called (or Grow/Shrink)? sal_uInt8 NeighbourhoodAdjustment( const SwFrm* pFrm ) const { return IsPageFrm() ? NA_ONLY_ADJUST : _NeighbourhoodAdjustment( pFrm ); } }; diff --git a/sw/source/core/inc/ftnfrm.hxx b/sw/source/core/inc/ftnfrm.hxx index c73682a8f705..d78db52d1cff 100644 --- a/sw/source/core/inc/ftnfrm.hxx +++ b/sw/source/core/inc/ftnfrm.hxx @@ -35,12 +35,10 @@ class SwTxtFtn; class SwBorderAttrs; class SwFtnFrm; -//Fuer Fussnoten gibt es einen Speziellen Bereich auf der Seite. Dieser -//Bereich ist ein SwFtnContFrm. -//Jede Fussnote ist durch einen SwFtnFrm abgegrenzt, dieser nimmt die -//Fussnotenabsaetze auf. SwFtnFrm koennen aufgespalten werden, sie gehen -//dann auf einer anderen Seite weiter. - +// There exists a special section on a page for footnotes. It's called +// SwFtnContFrm. Each footnote is separated by a SwFtnFrm which contains +// the paragraphs of a footnote. SwFtnFrm can be splitted and will then +// continue on another page. class SwFtnContFrm: public SwLayoutFrm { public: @@ -59,17 +57,17 @@ public: class SwFtnFrm: public SwLayoutFrm { - //Zeiger auf den FtnFrm in dem die Fussnote weitergefuehrt wird: - // 0 wenn kein Follow vorhanden, - // this beim letzten - // der Follow sonst. + // Pointer to FtnFrm in which the footnote will be continued: + // - 0 no following existent + // - this for the last one + // - otherwise the following FtnFrm SwFtnFrm *pFollow; - SwFtnFrm *pMaster; //Der FtnFrm dessen Follow ich bin. - SwCntntFrm *pRef; //In diesem CntntFrm steht die Fussnotenref. - SwTxtFtn *pAttr; //Fussnotenattribut (zum wiedererkennen) + SwFtnFrm *pMaster; // FtnFrm from which I am the following + SwCntntFrm *pRef; // in this CntntFrm is the footnote reference + SwTxtFtn *pAttr; // footnote attribute (for recognition) - sal_Bool bBackMoveLocked : 1; //Absaetze in dieser Fussnote duerfen derzeit - //nicht rueckwaerts fliessen. + // if true paragraphs in this footnote are NOT permitted to flow backwards + sal_Bool bBackMoveLocked : 1; // #i49383# - control unlock of position of lower anchored objects. bool mbUnlockPosOfLowerObjs : 1; #ifdef DBG_UTIL @@ -120,7 +118,7 @@ public: void UnlockBackMove() { bBackMoveLocked = sal_False;} sal_Bool IsBackMoveLocked() { return bBackMoveLocked; } - // Verhindert, dass der letzte Inhalt den SwFtnFrm mitloescht (Cut()) + // prevents that the last content deletes the SwFtnFrm as well (Cut()) inline void ColLock() { bColLocked = sal_True; } inline void ColUnlock() { bColLocked = sal_False; } |