// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright (C) 1995 Matthias Ettrich
+/**
+ * \file lyxrow.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- *======================================================*/
-
-#ifndef _LYXROW_H
-#define _LYXROW_H
+ * \author Matthias Ettrich
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ *
+ * Metrics for an on-screen text row.
+ */
-//#include "lyxparagraph.h"
+#ifndef LYXROW_H
+#define LYXROW_H
-class LyXParagraph;
+#include "support/types.h"
///
-struct Row {
+class Row {
+public:
+ ///
+ Row();
+ ///
+ Row(lyx::pos_type pos);
+ ///
+ void pos(lyx::pos_type p);
+ ///
+ lyx::pos_type pos() const;
+ ///
+ void endpos(lyx::pos_type p);
+ ///
+ lyx::pos_type endpos() const;
+ ///
+ void height(unsigned int h) { height_ = h; }
///
- LyXParagraph *par;
+ unsigned int height() const { return height_; }
///
- int pos;
+ void width(unsigned int w);
///
- unsigned short baseline;
+ unsigned int width() const;
///
- /** what is missing to a full row can be negative.
- Needed for hfills, flushright, block etc. */
- int fill;
+ void ascent_of_text(unsigned int a);
///
- unsigned short height;
+ unsigned int ascent_of_text() const;
///
- unsigned short ascent_of_text;
-
+ void top_of_text(unsigned int top);
///
- Row* next;
+ unsigned int top_of_text() const;
///
- Row* previous;
+ void baseline(unsigned int b);
+ ///
+ unsigned int baseline() const;
+ /// return true if this row is the start of a paragraph
+ bool isParStart() const;
+ /// return the cached y position
+ unsigned int y_offset() const { return y_offset_; }
+ /// cache the y position
+ void y_offset(unsigned int newy) { y_offset_ = newy; }
+ /// current debugging only
+ void dump(const char * = "") const;
+
+private:
+ /// first pos covered by this row
+ lyx::pos_type pos_;
+ /// one behind last pos covered by this row
+ lyx::pos_type end_;
+ ///
+ unsigned int height_;
+ ///
+ unsigned int width_;
+ /// cached y position
+ unsigned int y_offset_;
+ /// 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_;
};
+
+class RowMetrics {
+public:
+ RowMetrics();
+ /// width of a separator (i.e. space)
+ double separator;
+ /// width of hfills in the body
+ double hfill;
+ /// width of hfills in the label
+ double label_hfill;
+ /// the x position of the row
+ double x;
+};
+
+
#endif