lyx_mirror/src/BufferView.h

188 lines
4.9 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 "support/types.h"
#include <boost/utility.hpp>
#include <string>
class Buffer;
class Change;
class DocIterator;
class ErrorList;
class FuncRequest;
class FuncStatus;
class Language;
class LCursor;
class LyXText;
class LyXScreen;
class LyXView;
class Painter;
class ParIterator;
/**
* A buffer view 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.
*/
class BufferView : boost::noncopyable {
public:
/**
* Create a view with the given owner main window,
* of the given dimensions.
*/
BufferView(LyXView * owner, int w, int h);
~BufferView();
/// set the buffer we are viewing
void setBuffer(Buffer * b);
/// 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;
/// resize event has happened
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);
/** 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.
*/
void update(bool fitcursor = true, bool forceupdate = true);
/// 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();
/// FIXME
bool available() 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);
/// return the current change at the cursor
Change const getCurrentChange();
/// return the lyxtext we are using
LyXText * getLyXText();
/// return the lyxtext we are using
LyXText const * getLyXText() const;
/// simple replacing. Use the font of the first selected character
void replaceSelectionWithString(std::string const & str);
/// move cursor to the named label
void gotoLabel(std::string const & label);
/// 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);
/// hide the cursor if it is visible
void hideCursor();
/// 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);
/// return the pixel width of the document view
int workWidth() const;
/// return the pixel height of the document view
int workHeight() const;
/// switch between primary and secondary keymaps for RTL entry
void switchKeyMap();
/// 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);
/// return true for events that will handle
FuncStatus getStatus(FuncRequest const & cmd);
/// execute the given function
bool dispatch(FuncRequest const & argument);
/// clear the X selection
void unsetXSel();
/// access to offset
int offset_ref() const;
/// access to anchor
lyx::pit_type anchor_ref() const;
/// access to full cursor
LCursor & cursor();
/// access to full cursor
LCursor const & cursor() const;
///
LyXText * text() const;
///
void setCursor(ParIterator const & par, lyx::pos_type pos);
/* 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);
private:
///
class Pimpl;
///
friend class BufferView::Pimpl;
///
Pimpl * pimpl_;
};
#endif // BUFFERVIEW_H