lyx_mirror/src/TexRow.h
Richard Heck 2ace7ba9e6 Fix doxy.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27211 a592a061-630c-0410-9148-cb99ea01b6c8
2008-10-31 14:13:44 +00:00

96 lines
1.9 KiB
C++

// -*- C++ -*-
/**
* \file TexRow.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Matthias Ettrich
* \author Lars Gullik Bjønnes
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef TEXROW_H
#define TEXROW_H
#include <vector>
namespace lyx {
/// Represents the correspondence between paragraphs and the generated
/// LaTeX file
class TexRow {
public:
///
TexRow() : lastid(-1), lastpos(-1) {}
/// Clears structure
void reset();
/// Define what paragraph and position the next row will represent
void start(int id, int pos);
/// Insert node when line is completed
void newline();
/**
* getIdFromRow - find pid and position for a given row
* @param row row number to find
* @param id set to id if found
* @param pos set to paragraph position if found
* @return true if found, false otherwise
*
* If the row could not be found, pos is set to zero and
* id is set to -1
*/
bool getIdFromRow(int row, int & id, int & pos) const;
/**
* getRowFromIdPos - find row containing a given id and pos
* @param id of the paragraph
* @param pos a given position in that paragraph
* @return the row number within the rowlist
*/
int getRowFromIdPos(int id, int pos) const;
/// Returns the number of rows contained
int rows() const { return rowlist.size(); }
/// an individual id/pos <=> row mapping
class RowItem {
public:
RowItem(int id, int pos)
: id_(id), pos_(pos)
{}
/// paragraph id
int id() const { return id_; }
/// set paragraph position
void pos(int p) { pos_ = p; }
/// paragraph position
int pos() const { return pos_; }
private:
RowItem();
int id_;
int pos_;
};
///
typedef std::vector<RowItem> RowList;
private:
/// container of id/pos <=> row mapping
RowList rowlist;
/// Last paragraph
int lastid;
/// Last position
int lastpos;
};
} // namespace lyx
#endif // TEXROW_H