BufferParams.h: add comment

[lyx.git] / src / TextMetrics.h

diff --git a/src/TextMetrics.h b/src/TextMetrics.h
index 22197707014f4f1560e7d9d1f886a99f39dc2a5a..b601af7bd26a7d057678c6b1780590017804736b 100644 (file)
--- a/src/TextMetrics.h
+++ b/src/TextMetrics.h
@@ -24,17 +24,17 @@
 namespace lyx {
 
 class BufferView;
-class LyXText;
+class Text;
 class MetricsInfo;
 
-/// A map from a LyXText to the map of paragraphs metrics
+/// A map from a Text to the map of paragraphs metrics
 class TextMetrics
 {
 public:
        /// Default constructor (only here for STL containers).
        TextMetrics(): text_(0) {}
        /// The only useful constructor.
-       TextMetrics(BufferView *, LyXText *);
+       TextMetrics(BufferView *, Text *);
        ///
        ParagraphMetrics const & parMetrics(pit_type) const;
        ///
@@ -90,18 +90,28 @@ private:
        /// Calculate and set the height of the row
        void setHeightOfRow(pit_type, Row & row);
 
+// Temporary public:
+public:
        /// returns the column near the specified x-coordinate of the row.
        /// x is an absolute screen coord, it is set to the real beginning
        /// of this column.
        pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
                bool & boundary) const;
 
+       /// returns pos in given par at given x coord.
+       pos_type x2pos(pit_type pit, int row, int x) const;
+       
+       // FIXME: is there a need for this?
+       //int pos2x(pit_type pit, pos_type pos) const;
+
+private:
+
        /// The BufferView owner.
        BufferView * bv_;
 
        /// The text contents (the model).
        /// \todo FIXME: this should be const.
-       LyXText * text_;
+       Text * text_;
 
        bool main_text_;
        /// A map from paragraph index number to paragraph metrics
@@ -115,8 +125,8 @@ private:
        /*
        /// A map from paragraph index number to screen point
        typedef std::map<pit_type, Point> InnerParPosCache;
-       /// A map from a LyXText to the map of paragraphs to screen points
-       typedef std::map<LyXText const *, InnerParPosCache> ParPosCache;
+       /// A map from a Text to the map of paragraphs to screen points
+       typedef std::map<Text const *, InnerParPosCache> ParPosCache;
        /// Paragraph grouped by owning text
        ParPosCache pars_;
        */