#ifndef BUFFER_VIEW_H
#define BUFFER_VIEW_H
-#include "coordcache.h"
-#include "cursor.h"
-#include "metricsinfo.h"
-#include "UpdateFlags.h"
+#include "Dimension.h"
+#include "update_flags.h"
+
+#include "support/strfwd.h"
#include "support/types.h"
-#include <boost/utility.hpp>
-#include <boost/signal.hpp>
+#include <boost/noncopyable.hpp>
#include <utility>
#include <string>
namespace support { class FileName; }
+namespace frontend { class Painter; }
+namespace frontend { class GuiBufferViewDelegate; }
+
class Buffer;
class Change;
+class CoordCache;
+class Cursor;
class DocIterator;
class FuncRequest;
class FuncStatus;
class Intl;
-class Language;
-class LCursor;
-class LyXText;
+class Inset;
class ParIterator;
+class ParagraphMetrics;
+class Text;
+class TextMetrics;
class ViewMetricsInfo;
+enum CursorStatus {
+ CUR_INSIDE,
+ CUR_ABOVE,
+ CUR_BELOW
+};
+
/// Scrollbar Parameters.
struct ScrollbarParameters
{
* 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();
-
+ ///
+ BufferView(Buffer & buffer);
+ ///
~BufferView();
- /// set the buffer we are viewing.
- /// \todo FIXME: eventually, we will create a new BufferView
- /// when switching Buffers, so this method should go.
- void setBuffer(Buffer * b);
/// return the buffer being viewed.
- Buffer * buffer() const;
-
- /// resize the BufferView.
- void resize();
-
- /// redisplay the referenced buffer.
- void reload();
- /// load a buffer into the view.
- bool loadLyXFile(support::FileName const & name, bool tolastfiles = true);
-
- /// perform pending painting updates.
- /** \c fitcursor means first
- * to do a fitcursor, and to force an update if screen
- * position changes. \c forceupdate means to force an update
- * in any case.
- * \retval (false, xxx) if no redraw is required
- * \retval (true, true) if a single paragraph redraw is needed
- * \retval (true, false) if a full redraw is needed
+ 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
*/
- std::pair<bool, bool> update(Update::flags flags = Update::FitCursor | Update::Force);
+ void processUpdateFlags(Update::flags flags);
/// move the screen to fit the cursor.
/// Only to be called with good y coordinates (after a bv::metrics)
ScrollbarParameters const & scrollbarParameters() const;
/// Save the current position as bookmark.
- /// if persistent=false, save to temp_bookmark
- void saveBookmark(bool persistent);
- /// goto a specified position.
- void moveToPosition(
- int par_id, ///< Paragraph ID, \sa Paragraph
- pos_type par_pos ///< Position in the \c Paragraph
+ /// 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;
- /// return the lyxtext we are using.
- LyXText * getLyXText();
-
- /// return the lyxtext we are using.
- LyXText const * getLyXText() const;
-
/// move cursor to the named label.
void gotoLabel(docstring const & label);
/// center the document view around the cursor.
void center();
- /// scroll document by the given number of lines of default height.
- void scroll(int lines);
+ /// 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.
/// return the pixel height of the document view.
int workHeight() const;
- /// switch between primary and secondary keymaps for RTL entry.
- void switchKeyMap();
+ /// 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.
- bool dispatch(FuncRequest const & argument);
+ /// \return the Update::flags for further metrics update.
+ Update::flags dispatch(FuncRequest const & argument);
/// request an X11 selection.
/// \return the selected string.
/// clear the X11 selection.
void clearSelection();
- /// resize method helper for \c WorkArea
+ /// resize the BufferView.
/// \sa WorkArea
- /// \sa resise
- void workAreaResize(int width, int height);
+ void resize(int width, int height);
/// dispatch method helper for \c WorkArea
/// \sa WorkArea
- /// \retval (false, xxx) if no redraw is required
- /// \retval (true, true) if a single paragraph redraw is needed
- /// \retval (true, false) if a full redraw is needed
- std::pair<bool, bool> workAreaDispatch(FuncRequest const & ev);
+ void mouseEventDispatch(FuncRequest const & ev);
/// access to anchor.
pit_type anchor_ref() const;
+ ///
+ CursorStatus cursorStatus(DocIterator const & dit) const;
/// access to full cursor.
- LCursor & cursor();
+ Cursor & cursor();
/// access to full cursor.
- LCursor const & cursor() const;
+ 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.
- void mouseSetCursor(LCursor & cur);
+ bool mouseSetCursor(Cursor & cur, bool select = false);
/// sets the selection.
/* When \c backwards == false, set anchor
void updateMetrics(bool singlepar = false);
///
- CoordCache & coordCache() {
- return coord_cache_;
- }
+ TextMetrics const & textMetrics(Text const * t) const;
+ TextMetrics & textMetrics(Text const * t);
///
- CoordCache const & coordCache() const {
- return coord_cache_;
- }
+ ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
+
+ ///
+ CoordCache & coordCache();
+ ///
+ CoordCache const & coordCache() const;
+
+ ///
+ 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 & getIntl();
///
- Intl const & getIntl() const { return *intl_.get(); }
+ Intl const & getIntl() const;
+ //
+ // Messages to the GUI
+ //
/// This signal is emitted when some message shows up.
- boost::signal<void(docstring)> message;
+ void message(docstring const & msg);
/// This signal is emitted when some dialog needs to be shown.
- boost::signal<void(std::string name)> showDialog;
+ void showDialog(std::string const & name);
/// This signal is emitted when some dialog needs to be shown with
/// some data.
- boost::signal<void(std::string name,
- std::string data)> showDialogWithData;
+ void showDialogWithData(std::string const & name, std::string const & data);
/// This signal is emitted when some inset dialogs needs to be shown.
- boost::signal<void(std::string name, std::string data,
- InsetBase * inset)> showInsetDialog;
+ void showInsetDialog(std::string const & name, std::string const & data,
+ Inset * inset);
/// This signal is emitted when some dialogs needs to be updated.
- boost::signal<void(std::string name,
- std::string data)> updateDialog;
+ void updateDialog(std::string const & name, std::string const & data);
+
+ ///
+ void setGuiDelegate(frontend::GuiBufferViewDelegate *);
- /// This signal is emitted when the layout at the cursor is changed.
- boost::signal<void(std::string layout)> layoutChanged;
+ ///
+ 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_;
+ Buffer & buffer_;
- ///
- 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_;
- ///
- LCursor cursor_;
- ///
- bool multiparsel_cache_;
- ///
- pit_type anchor_ref_;
- ///
- int offset_ref_;
+ void updateOffsetRef();
- /// keyboard mapping object.
- boost::scoped_ptr<Intl> const intl_;
+ struct Private;
+ Private * const d;
};
+/// 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
projects / lyx.git / blobdiff