X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferView.h;h=bceaf1f82fd92d4d6bdffc091c312130802d6bd6;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=a8cae7000b5b5937fe9771b9d549f26937ec5733;hpb=1b3f5ee46ff2924c4b374f52ad6317b5fd7ac9a5;p=lyx.git diff --git a/src/BufferView.h b/src/BufferView.h index a8cae7000b..bceaf1f82f 100644 --- a/src/BufferView.h +++ b/src/BufferView.h @@ -15,173 +15,291 @@ #ifndef BUFFER_VIEW_H #define BUFFER_VIEW_H +#include "coordcache.h" +#include "cursor.h" +#include "metricsinfo.h" +#include "TextMetrics.h" +#include "UpdateFlags.h" + #include "support/types.h" +#include #include +#include +#include #include + +namespace lyx { + +namespace support { class FileName; } + class Buffer; class Change; -class Encoding; -class ErrorList; +class DocIterator; class FuncRequest; -class InsetBase; -class InsetOld; -class Language; +class FuncStatus; +class Intl; class LCursor; class LyXText; -class LyXScreen; -class LyXView; -class Painter; class ParIterator; -class PosIterator; -class TeXErrors; -class UpdatableInset; +class ParagraphMetrics; +class ViewMetricsInfo; + +/// 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 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. - * - * Eventually we will allow several views onto a single - * buffer, but not yet. + * It is the official interface between the LyX core and + * the frontend WorkArea. + * + * \sa WorkArea + * \sa Buffer + * \sa CoordCache */ class BufferView : boost::noncopyable { public: - /** - * Create a view with the given owner main window, - * of the given dimensions. - */ - BufferView(LyXView * owner, int x, int y, int w, int h); + BufferView(); ~BufferView(); - /// set the buffer we are viewing + /// 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 + /// return the buffer being viewed. Buffer * buffer() const; - /// return the painter object for drawing onto the view - Painter & painter() const; - /// return the screen object for handling re-drawing - LyXScreen & screen() const; - /// return the owning main view - LyXView * owner() const; - - /// return the visible top y - int top_y() const; - - /// set the visible top y - void top_y(int); - - /// resize event has happened + /// resize the BufferView. void resize(); - /// reload the contained buffer - void reload(); - /// create a new buffer based on template - void newFile(std::string const & fname, std::string const & tname, - bool named = true); - /// load a buffer into the view - bool loadLyXFile(std::string const & name, bool tolastfiles = true); + /// load a buffer into the view. + bool loadLyXFile(support::FileName const & name, bool tolastfiles = true); - /// fit the user cursor within the visible view + /// 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(); - /// perform pending painting updates - void update(); - /// reset the scrollbar to reflect current view position + /// reset the scrollbar to reflect current view position. void updateScrollbar(); - /// FIXME - void redoCurrentBuffer(); + /// return the Scrollbar Parameters. + 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, try par_id first, and then par_pit + /// return the par_pit and par_id of the new paragraph + boost::tuple moveToPosition( + pit_type par_pit, ///< Paragraph pit, used when par_id is zero or invalid. + int par_id, ///< Paragraph ID, \sa Paragraph + pos_type par_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); + + /// set the cursor based on the given TeX source row. + void setCursorFromRow(int row); - /// FIXME - bool available() const; + /// 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. + void scrollDocView(int pixels); + /// Set the cursor position based on the scrollbar one. + void setCursorFromScrollbar(); - /// 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); + /// return the pixel width of the document view. + int workWidth() const; + /// return the pixel height of the document view. + int workHeight() const; - /// return the current change at the cursor - Change const getCurrentChange(); + /// switch between primary and secondary keymaps for RTL entry. + void switchKeyMap(); - /// return the lyxtext we are using - LyXText * getLyXText() const; + /// return true for events that will handle. + FuncStatus getStatus(FuncRequest const & cmd); + /// execute the given function. + bool dispatch(FuncRequest const & argument); - /// return the parent language of the given inset - Language const * getParentLanguage(InsetOld * inset) const; + /// request an X11 selection. + /// \return the selected string. + docstring const requestSelection(); + /// clear the X11 selection. + void clearSelection(); - /// simple replacing. Use the font of the first selected character - void replaceSelectionWithString(std::string const & str); + /// resize method helper for \c WorkArea + /// \sa WorkArea + /// \sa resise + void workAreaResize(int width, int height); - /// move cursor to the named label - void gotoLabel(std::string const & label); + /// dispatch method helper for \c WorkArea + /// \sa WorkArea + /// \retval true if a redraw is needed + bool workAreaDispatch(FuncRequest const & ev); - /// get the stored error list - ErrorList const & getErrorList() const; - /// show the error list to the user - void showErrorList(std::string const &) const; - /// set the cursor based on the given TeX source row - void setCursorFromRow(int row); + /// access to anchor. + pit_type anchor_ref() const; - /// Inserts a lyx file at cursor position. return false if it fails - bool insertLyXFile(std::string const & file); + /// access to full cursor. + LCursor & cursor(); + /// access to full cursor. + LCursor 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(LCursor & cur, LCursor & old); + /// sets cursor. + /// This is used when handling LFUN_MOUSE_PRESS. + bool mouseSetCursor(LCursor & 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, + 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); - /// FIXME - bool fitLockedInsetCursor(int x, int y, int asc, int desc); + /// + TextMetrics const & textMetrics(LyXText const * t) const; + TextMetrics & textMetrics(LyXText const * t); + /// + ParagraphMetrics const & parMetrics(LyXText const *, pit_type) const; - /// hide the cursor if it is visible - void hideCursor(); + /// + CoordCache & coordCache() { + return coord_cache_; + } + /// + CoordCache const & coordCache() const { + return coord_cache_; + } + /// get this view's keyboard map handler. + Intl & getIntl() { return *intl_.get(); } + /// + Intl const & getIntl() const { return *intl_.get(); } - /// 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 - void scrollDocView(int); + /// This signal is emitted when some message shows up. + boost::signal message; - /// return the pixel width of the document view - int workWidth() const; - /// return the pixel height of the document view - int workHeight() const; + /// This signal is emitted when some dialog needs to be shown. + boost::signal showDialog; - /// switch between primary and secondary keymaps for RTL entry - void switchKeyMap(); + /// This signal is emitted when some dialog needs to be shown with + /// some data. + boost::signal showDialogWithData; - /// get the contents of the window system clipboard - std::string const getClipboard() const; - /// fill the window system clipboard - void stuffClipboard(std::string const &) const; - /// tell the window system we have a selection - void haveSelection(bool sel); + /// This signal is emitted when some inset dialogs needs to be shown. + boost::signal showInsetDialog; - /// execute the given function - bool dispatch(FuncRequest const & argument); - - /// clear the X selection - void unsetXSel(); + /// This signal is emitted when some dialogs needs to be updated. + boost::signal updateDialog; - /// access to full cursor - LCursor & cursor(); - /// access to full cursor - LCursor const & cursor() const; + /// This signal is emitted when the layout at the cursor is changed. + boost::signal layoutChanged; + +private: + /// + bool multiParSel(); /// - LyXText * text() const; + int width_; /// - void setCursor(ParIterator const & par, lyx::pos_type pos); + int height_; /// - void putSelectionAt(PosIterator const & cur, int length, bool backwards); + ScrollbarParameters scrollbarParameters_; -private: /// - struct Pimpl; + 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_; /// - friend struct BufferView::Pimpl; + bool multiparsel_cache_; /// - Pimpl * pimpl_; + pit_type anchor_ref_; + /// + int offset_ref_; + + /// keyboard mapping object. + boost::scoped_ptr const intl_; + + /// last visited inset (kept to send setMouseHover(false) ) + InsetBase * last_inset_; + + /// A map from a LyXText to the associated text metrics + typedef std::map TextMetricsCache; + mutable TextMetricsCache text_metrics_; }; + +} // namespace lyx + #endif // BUFFERVIEW_H