]> git.lyx.org Git - lyx.git/blobdiff - src/lyxrow.h
fix some C++ parsing bugs
[lyx.git] / src / lyxrow.h
index e2593fdc7c96be7175eafce864e9d8ea99ff81c5..68f229f7fb44ec8268f3e0d33ef544732b75699c 100644 (file)
@@ -1,21 +1,19 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file lyxrow.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author unknown
  *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
+ * Full author contact details are available in file CREDITS
  *
- * ====================================================== */
+ * Metrics for an on-screen text row.
+ */
 
 #ifndef LYXROW_H
 #define LYXROW_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "support/types.h"
 
 class Paragraph;
@@ -53,6 +51,10 @@ public:
        ///
        unsigned short ascent_of_text() const;
        ///
+       void top_of_text(unsigned int top);
+       ///
+       unsigned int top_of_text() const;
+       ///
        void baseline(unsigned int b);
        ///
        unsigned int baseline() const;
@@ -64,6 +66,40 @@ public:
        void previous(Row * r);
        ///
        Row * previous() const;
+
+       /// return true if this row is the start of a paragraph
+       bool isParStart() const;
+
+       /// return true if this  row is the end of a paragraph
+       bool isParEnd() const;
+
+       /// return the position of the last character in this row
+       lyx::pos_type lastPos() const;
+       /// return the position of the last normal, printable character in this row
+       lyx::pos_type lastPrintablePos() const;
+
+       /**
+        * Returns the number of separators.
+        * The separator on the very last column doesnt count.
+        */
+       int numberOfSeparators() const;
+
+       /**
+        * Returns the number of hfills. It works like a LaTeX \hfill:
+        * the hfills at the beginning and at the end are ignored.
+        * This is much more useful than not to ignore!
+        */
+       int numberOfHfills() const;
+
+       /// Returns the number of hfills in the manual label. See numberOfHfills().
+       int numberOfLabelHfills() const;
+
+       /**
+        * Returns true if a expansion is needed at the given position.
+        * Rules are given by LaTeX
+        */
+       bool hfillExpansion(lyx::pos_type pos) const;
+
 private:
        ///
        Paragraph * par_;
@@ -76,8 +112,10 @@ private:
        unsigned short height_;
        ///
        unsigned int width_;
-       ///
+       /// ascent from baseline including prelude space
        unsigned short ascent_of_text_;
+       /// the top of the real text in the row
+       unsigned int top_of_text_;
        ///
        unsigned int baseline_;
        ///
@@ -86,32 +124,4 @@ private:
        Row * previous_;
 };
 
-
-inline
-Paragraph * Row::par()
-{
-       return par_;
-}
-
-
-inline
-Paragraph * Row::par() const
-{
-       return par_;
-}
-
-
-inline
-unsigned short Row::height() const
-{
-       return height_;
-}
-
-
-inline
-Row * Row::next() const
-{
-       return next_;
-}
-
 #endif