lyx_mirror/src/BufferView.h

343 lines
9.0 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file BufferView.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Alfredo Braustein
* \author Lars Gullik Bj<EFBFBD>nnes
* \author John Levon
* \author J<EFBFBD>rgen Vigna
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
#include "CoordCache.h"
#include "Cursor.h"
#include "MetricsInfo.h"
#include "TextMetrics.h"
#include "update_flags.h"
#include "support/types.h"
#include <boost/noncopyable.hpp>
#include <utility>
#include <string>
namespace lyx {
namespace support { class FileName; }
namespace frontend { class Painter; }
namespace frontend { class GuiBufferViewDelegate; }
class Buffer;
class Change;
class DocIterator;
class FuncRequest;
class FuncStatus;
class Intl;
class Cursor;
class Text;
class ParIterator;
class ParagraphMetrics;
class ViewMetricsInfo;
enum CursorStatus {
CUR_INSIDE,
CUR_ABOVE,
CUR_BELOW
};
/// Scrollbar Parameters.
struct ScrollbarParameters
{
void reset(int h = 0, int p = 0, int l = 0)
{
height = h;
position = p;
lineScrollHeight = l;
}
/// Total document height in pixels.
int height;
/// Current position in the document in pixels.
int position;
/// Line-scroll amount in pixels.
int lineScrollHeight;
};
/// Screen view of a Buffer.
/**
* A BufferView encapsulates a view onto a particular
* buffer, and allows access to operate upon it. A view
* is a sliding window of the entire document rendering.
* It is the official interface between the LyX core and
* the frontend WorkArea.
*
* \sa WorkArea
* \sa Buffer
* \sa CoordCache
*/
class BufferView : boost::noncopyable {
public:
///
BufferView(Buffer & buffer);
///
~BufferView();
/// return the buffer being viewed.
Buffer & buffer();
Buffer const & buffer() const;
/// perform pending metrics updates.
/** \c Update::FitCursor means first to do a FitCursor, and to
* force an update if screen position changes.
* \c Update::Force means to force an update in any case.
* \retval true if a screen redraw is needed
*/
bool update(Update::flags flags = Update::FitCursor | Update::Force);
/// move the screen to fit the cursor.
/// Only to be called with good y coordinates (after a bv::metrics)
bool fitCursor();
/// reset the scrollbar to reflect current view position.
void updateScrollbar();
/// return the Scrollbar Parameters.
ScrollbarParameters const & scrollbarParameters() const;
/// Save the current position as bookmark.
/// if idx == 0, save to temp_bookmark
void saveBookmark(unsigned int idx);
/// goto a specified position, try top_id first, and then bottom_pit.
/// \return true if success
bool moveToPosition(
pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
int top_id, ///< Paragraph ID, \sa Paragraph
pos_type top_pos ///< Position in the \c Paragraph
);
/// return the current change at the cursor.
Change const getCurrentChange() const;
/// move cursor to the named label.
void gotoLabel(docstring const & label);
/// set the cursor based on the given TeX source row.
void setCursorFromRow(int row);
/// center the document view around the cursor.
void center();
/// scroll down document by the given number of pixels.
void scrollDown(int pixels);
/// scroll up document by the given number of pixels.
void scrollUp(int pixels);
/// scroll document by the given number of pixels.
void scroll(int pixels);
/// Scroll the view by a number of pixels.
void scrollDocView(int pixels);
/// Set the cursor position based on the scrollbar one.
void setCursorFromScrollbar();
/// return the pixel width of the document view.
int workWidth() const;
/// return the pixel height of the document view.
int workHeight() const;
/// translate and insert a character, using the correct keymap.
void translateAndInsert(char_type c, Text * t, Cursor & cur);
/// return true for events that will handle.
FuncStatus getStatus(FuncRequest const & cmd);
/// execute the given function.
/// \return the Update::flags for further metrics update.
Update::flags dispatch(FuncRequest const & argument);
/// request an X11 selection.
/// \return the selected string.
docstring const requestSelection();
/// clear the X11 selection.
void clearSelection();
/// resize the BufferView.
/// \sa WorkArea
void resize(int width, int height);
/// dispatch method helper for \c WorkArea
/// \sa WorkArea
void mouseEventDispatch(FuncRequest const & ev);
/// access to anchor.
pit_type anchor_ref() const;
///
CursorStatus cursorStatus(DocIterator const & dit) const;
/// access to full cursor.
Cursor & cursor();
/// access to full cursor.
Cursor const & cursor() const;
/// sets cursor.
/// This will also open all relevant collapsable insets.
void setCursor(DocIterator const &);
/// Check deleteEmptyParagraphMechanism and update metrics if needed.
/// \retval true if an update was needed.
bool checkDepm(Cursor & cur, Cursor & old);
/// sets cursor.
/// This is used when handling LFUN_MOUSE_PRESS.
bool mouseSetCursor(Cursor & cur);
/// sets the selection.
/* When \c backwards == false, set anchor
* to \c cur and cursor to \c cur + \c length. When \c
* backwards == true, set anchor to \c cur and cursor to \c
* cur + \c length.
*/
void putSelectionAt(DocIterator const & cur,
the stuff from the sneak preview: For one, it still contains a few things that are already in CVS (the 'brown paperbag' changes). Secondly, this changes the ParagraphList to a std::vector but does not yet take full advantage of it except removing LyXText::parOffset() and similar. I had an extensive talk with my profiler and we are happy nevertheless. This also moves almost all Cut&Paste specific stuff from text.C to CutAndPaste.C. Much smaller interface now... Namespace CutAndPaste is now lyx::cap::. Was inconsistent with the rest.... Make ParagraphList a proper class. We'll need this later for a specialized erase/insert. Remove some unneeded prototypes and function declarations Use ParameterStruct directly instead of ShareContainer<ParameterStruct> Inline a few accesses to CursorSlice members as suggested by the profiler. Fix commandline conversion crash reported by Kayvan. Replace PosIterator by DocumentIterator. The latter can also iterate through math and nested text in math... Remove math specific hack from Documentiterator Derive InsetCollapsable from InsetText instead of using an InsetText member. This give us the opportunity to get rid of the InsetOld::owner_ backpointer. Cosmetics in CutAndPaste.C and cursor.C. Fix nasty crash (popping slices off an empty selection anchor). Add a few asserts. Remove all 'manual' update calls. We do now one per user interaction which is completely sufficient. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@8527 a592a061-630c-0410-9148-cb99ea01b6c8
2004-03-25 09:16:36 +00:00
int length, bool backwards);
/// return the internal \c ViewMetricsInfo.
/// This is used specifically by the \c Workrea.
/// \sa WorkArea
/// \sa ViewMetricsInfo
ViewMetricsInfo const & viewMetricsInfo();
/// update the internal \c ViewMetricsInfo.
/// \param singlepar indicates wether
void updateMetrics(bool singlepar = false);
///
TextMetrics const & textMetrics(Text const * t) const;
TextMetrics & textMetrics(Text const * t);
///
ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
///
CoordCache & coordCache() { return coord_cache_; }
///
CoordCache const & coordCache() const { return coord_cache_; }
///
Point getPos(DocIterator const & dit, bool boundary) const;
///
void draw(frontend::Painter & pain);
/// get this view's keyboard map handler.
Intl & getIntl() { return *intl_.get(); }
///
Intl const & getIntl() const { return *intl_.get(); }
//
// Messages to the GUI
//
/// This signal is emitted when some message shows up.
void message(docstring const & msg);
/// This signal is emitted when some dialog needs to be shown.
void showDialog(std::string const & name);
/// This signal is emitted when some dialog needs to be shown with
/// some data.
void showDialogWithData(std::string const & name, std::string const & data);
/// This signal is emitted when some inset dialogs needs to be shown.
void showInsetDialog(std::string const & name, std::string const & data,
Inset * inset);
/// This signal is emitted when some dialogs needs to be updated.
void updateDialog(std::string const & name, std::string const & data);
///
void setGuiDelegate(frontend::GuiBufferViewDelegate *);
///
docstring contentsOfPlaintextFile(std::string const & f, bool asParagraph);
// Insert plain text file (if filename is empty, prompt for one)
void insertPlaintextFile(std::string const & fileName, bool asParagraph);
private:
// the position relative to (0, baseline) of outermost paragraph
Point coordOffset(DocIterator const & dit, bool boundary) const;
/// Update current paragraph metrics.
/// \return true if no further update is needed.
bool singleParUpdate();
///
bool multiParSel();
/// Search recursively for the the innermost inset that covers (x, y) position.
/// \retval 0 if no inset is found.
Inset const * getCoveringInset(
Text const & text, //< The Text where we start searching.
int x, //< x-coordinate on screen
int y //< y-coordinate on screen
);
///
int width_;
///
int height_;
///
ScrollbarParameters scrollbarParameters_;
///
ViewMetricsInfo metrics_info_;
///
CoordCache coord_cache_;
///
Buffer & buffer_;
/// Estimated average par height for scrollbar.
int wh_;
///
void menuInsertLyXFile(std::string const & filen);
/// this is used to handle XSelection events in the right manner.
struct {
CursorSlice cursor;
CursorSlice anchor;
bool set;
} xsel_cache_;
///
Cursor cursor_;
///
bool multiparsel_cache_;
///
pit_type anchor_ref_;
///
int offset_ref_;
///
void updateOffsetRef();
///
bool need_centering_;
/// keyboard mapping object.
boost::scoped_ptr<Intl> const intl_;
/// last visited inset (kept to send setMouseHover(false) )
Inset * last_inset_;
/// A map from a Text to the associated text metrics
typedef std::map<Text const *, TextMetrics> TextMetricsCache;
mutable TextMetricsCache text_metrics_;
// Whom to notify. Not owned, so don't delete.
frontend::GuiBufferViewDelegate * gui_;
};
/// some space for drawing the 'nested' markers (in pixel)
inline int nestMargin() { return 15; }
/// margin for changebar
inline int changebarMargin() { return 12; }
/// right margin
inline int rightMargin() { return 10; }
} // namespace lyx
#endif // BUFFERVIEW_H