X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=f1897cb96449ddb3c9cdeaba07afe070a80b0c92;hb=fc2658eff011adb08192cf897416698c34aab268;hp=2481c286ba771d2696d41cb0f361e33def8e83f7;hpb=1b5f5e58ed43aeca64ad11af6a493a49699d1b2e;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index 2481c286ba..f1897cb964 100644 --- a/src/BufferView.h +++ b/src/BufferView.h @@ -15,49 +15,41 @@ #ifndef BUFFER_VIEW_H #define BUFFER_VIEW_H -#include "cursor.h" -#include "metricsinfo.h" +#include "update_flags.h" +#include "support/strfwd.h" #include "support/types.h" -#include -#include +namespace lyx { -#include +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 Menu; class ParIterator; -class ViewMetricsInfo; - -namespace Update { - enum flags { - FitCursor = 1, - Force = 2, - SinglePar = 4, - MultiParSel = 8 - }; - -inline flags operator|(flags const f, flags const g) -{ - return static_cast(int(f) | int(g)); -} - -inline flags operator&(flags const f, flags const g) -{ - return static_cast(int(f) & int(g)); -} - -} // namespace +class ParagraphMetrics; +class Point; +class Text; +class TextMetrics; + +enum CursorStatus { + CUR_INSIDE, + CUR_ABOVE, + CUR_BELOW +}; -/// Scrollbar Parameters +/// Scrollbar Parameters. struct ScrollbarParameters { void reset(int h = 0, int p = 0, int l = 0) @@ -67,220 +59,241 @@ struct ScrollbarParameters lineScrollHeight = l; } - /// The total document height in pixels + /// Total document height in pixels. int height; - /// The current position in the document, in pixels + /// Current position in the document in pixels. int position; - /// the line-scroll amount, in pixels + /// Line-scroll amount in pixels. int lineScrollHeight; }; +/// Screen view of a Buffer. /** - * A buffer view encapsulates a view onto a particular + * 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. * - * Eventually we will allow several views onto a single - * buffer, but not yet. + * \sa WorkArea + * \sa Buffer + * \sa CoordCache */ -class BufferView : boost::noncopyable { +class BufferView { public: - BufferView(); - + /// + BufferView(Buffer & buffer); + /// ~BufferView(); - /// set the buffer we are viewing - void setBuffer(Buffer * b); - /// return the buffer being viewed - Buffer * buffer() const; - - /// resize event has happened - void resize(); - - /// reload the contained buffer - void reload(); - /// load a buffer into the view - bool loadLyXFile(std::string const & name, bool tolastfiles = true); + /// return the buffer being viewed. + Buffer & buffer(); + Buffer const & buffer() const; - /** 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. - * \return true if a full updateMetrics() is needed. + /// 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); + void processUpdateFlags(Update::flags flags); - /// move the screen to fit the cursor. Only to be called with - /// good y coordinates (after a bv::metrics) + /// 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 + /// reset the scrollbar to reflect current view position. void updateScrollbar(); - /// return the Scrollbar Parameters + /// return the Scrollbar Parameters. ScrollbarParameters const & scrollbarParameters() const; - - /// Save the current position as bookmark i - void savePosition(unsigned int i); - /// Restore the position from bookmark i - void restorePosition(unsigned int i); - /// does the given bookmark have a saved position ? - bool isSavedPosition(unsigned int i); - /// save bookmarks to .lyx/session - void saveSavedPositions(); - - /// return the current change at the cursor + /// \return Tool tip for the given position. + docstring toolTip(int x, int y) const; + /// \return the context menu for the given position. + docstring contextMenu(int x, int y) 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; - /// 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(std::string const & label); + /// move cursor to the named label. + void gotoLabel(docstring const & label); - /// set the cursor based on the given TeX source row + /// set the cursor based on the given TeX source row. void setCursorFromRow(int row); - /// 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 the view by a number of pixels + /// Ensure the cursor is visible. + /// This method will automatically scroll and update the BufferView and updated + /// if needed. + void showCursor(); + /// 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 + /// return the pixel width of the document view. int workWidth() const; - /// return the pixel height of the document view + /// return the pixel height of the document view. int workHeight() const; - /// switch between primary and secondary keymaps for RTL entry - void switchKeyMap(); - /// return true for events that will handle + /// 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 + /// execute the given function. + /// \return true if the function has been processed. bool dispatch(FuncRequest const & argument); - /// - lyx::docstring const requestSelection(); - /// + /// request an X11 selection. + /// \return the selected string. + docstring const requestSelection(); + /// clear the X11 selection. void clearSelection(); - /// - void workAreaResize(int width, int height); + /// resize the BufferView. + /// \sa WorkArea + void resize(int width, int height); - /// a function should be executed from the workarea - bool workAreaDispatch(FuncRequest const & ev); + /// dispatch method helper for \c WorkArea + /// \sa WorkArea + void mouseEventDispatch(FuncRequest const & ev); - /// access to anchor - lyx::pit_type anchor_ref() const; + /// access to anchor. + pit_type anchor_ref() const; - /// access to full cursor - LCursor & cursor(); - /// access to full cursor - LCursor const & cursor() const; - /// sets cursor and open all relevant collapsable insets. + /// + 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 &); - /// sets cursor; this is used when handling LFUN_MOUSE_PRESS. - void mouseSetCursor(LCursor & cur); - - /* Sets the selection. When \c backwards == false, set anchor + /// 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, bool select = false); + + /// 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, int length, bool backwards); + + /// update the internal \c ViewMetricsInfo. + void updateMetrics(); + + /// + TextMetrics const & textMetrics(Text const * t) const; + TextMetrics & textMetrics(Text const * t); /// - ViewMetricsInfo const & viewMetricsInfo(); + ParagraphMetrics const & parMetrics(Text const *, pit_type) const; + + /// + CoordCache & coordCache(); + /// + CoordCache const & coordCache() const; + + /// + Point getPos(DocIterator const & dit, bool boundary) const; + + /// - void updateMetrics(bool singlepar = false); + void draw(frontend::Painter & pain); - /// get this view's keyboard map handler - Intl & getIntl() { return *intl_.get(); } + /// get this view's keyboard map handler. + 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 message; + void message(docstring const & msg); /// This signal is emitted when some dialog needs to be shown. - boost::signal showDialog; + void showDialog(std::string const & name); /// This signal is emitted when some dialog needs to be shown with - /// some data - boost::signal showDialogWithData; - - /// This signal is emitted when some inset dialogs needs to be shown. - boost::signal showInsetDialog; + /// some data. + void showDialog(std::string const & name, std::string const & data, + Inset * inset = 0); /// This signal is emitted when some dialogs needs to be updated. - boost::signal updateDialog; + void updateDialog(std::string const & name, std::string const & data); - /// This signal is emitted when the layout at the cursor is changed. - boost::signal layoutChanged; + /// + void setGuiDelegate(frontend::GuiBufferViewDelegate *); -private: /// - bool multiParSel(); + docstring contentsOfPlaintextFile(support::FileName const & f); + // Insert plain text file (if filename is empty, prompt for one) + void insertPlaintextFile(support::FileName const & f, bool asParagraph); + /// + void insertLyXFile(support::FileName const & f); + +private: + /// noncopyable + BufferView(BufferView const &); + void operator=(BufferView const &); + + // 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(); + + /// 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 + ) const; + /// int width_; /// int height_; /// - ScrollbarParameters scrollbarParameters_; + Buffer & buffer_; - /// - ViewMetricsInfo metrics_info_; + struct Private; + Private * const d; +}; - /// - Buffer * buffer_; +/// some space for drawing the 'nested' markers (in pixel) +inline int nestMargin() { return 15; } - /// Estimated average par height for scrollbar - int wh_; - /// - class Position { - public: - /// Filename - std::string filename; - /// Cursor paragraph Id - int par_id; - /// Cursor position - lyx::pos_type par_pos; - /// - Position() : par_id(0), par_pos(0) {} - /// - Position(std::string const & f, int id, lyx::pos_type pos) - : filename(f), par_id(id), par_pos(pos) {} - }; - /// - std::vector saved_positions; - /// - 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_; - /// - lyx::pit_type anchor_ref_; - /// - int offset_ref_; +/// margin for changebar +inline int changebarMargin() { return 12; } - /// keyboard mapping object - boost::scoped_ptr const intl_; -}; +/// right margin +inline int rightMargin() { return 10; } + +} // namespace lyx #endif // BUFFERVIEW_H