src/lyxrow.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxrow.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Matthias Ettrich
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS
  11  *
  12  * Metrics for an on-screen text row.
  13  */
  14
  15 #ifndef LYXROW_H
  16 #define LYXROW_H
  17
  18 #include "support/types.h"
  19
  20 ///
  21 class Row {
  22 public:
  23         ///
  24         Row();
  25         ///
  26         Row(lyx::pos_type pos);
  27         ///
  28         void pos(lyx::pos_type p);
  29         ///
  30         lyx::pos_type pos() const;
  31         ///
  32         void fill(int f);
  33         ///
  34         int fill() const;
  35         ///
  36         void height(unsigned short h);
  37         ///
  38         unsigned short height() const;
  39         ///
  40         void width(unsigned int w);
  41         ///
  42         unsigned int width() const;
  43         ///
  44         void ascent_of_text(unsigned short a);
  45         ///
  46         unsigned short ascent_of_text() const;
  47         ///
  48         void top_of_text(unsigned int top);
  49         ///
  50         unsigned int top_of_text() const;
  51         ///
  52         void baseline(unsigned int b);
  53         ///
  54         unsigned int baseline() const;
  55         /// return true if this row is the start of a paragraph
  56         bool isParStart() const;
  57         /// return the cached y position
  58         unsigned int y() const;
  59         /// cache the y position
  60         void y(unsigned int newy);
  61         /// current debugging only
  62         void dump(const char * = "") const;
  63 private:
  64         ///
  65         lyx::pos_type pos_;
  66         /** what is missing to a full row. Can be negative.
  67           Needed for hfills, flushright, block etc. */
  68         mutable int fill_;
  69         ///
  70         unsigned short height_;
  71         ///
  72         unsigned int width_;
  73         /// cached y position
  74         unsigned int y_;
  75         /// ascent from baseline including prelude space
  76         unsigned short ascent_of_text_;
  77         /// the top of the real text in the row
  78         unsigned int top_of_text_;
  79         ///
  80         unsigned int baseline_;
  81 };
  82
  83 #endif