// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1998 The LyX Team.
+/**
+ * \file insettext.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
+ * \author Jürgen Vigna
*
- *======================================================
+ * Full author contact details are available in file CREDITS.
*/
-// The pristine updatable inset: Text
-
#ifndef INSETTEXT_H
#define INSETTEXT_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "updatableinset.h"
+#include "RowList_fwd.h"
+#include "lyxfont.h"
+#include "lyxtext.h"
-#include "inset.h"
-#include "LString.h"
-#include "LColor.h"
#include "support/types.h"
-#include <boost/shared_ptr.hpp>
+#include "frontends/mouse_state.h"
-class Painter;
-class BufferView;
class Buffer;
class BufferParams;
-class LyXCursor;
-class LyXText;
+class BufferView;
+class Dimension;
+class LColor_color;
+class CursorSlice;
+class Painter;
+class ParagraphList;
class Row;
-class Paragraph;
+
/**
A text inset is like a TeX box to write full text
(including styles and other insets) in a given space.
- @author: Jürgen Vigna
*/
class InsetText : public UpdatableInset {
public:
- ///
- /// numbers need because of test if codeA < codeB
- ///
- enum UpdateCodes {
- ///
- NONE = 0,
- ///
- CURSOR = 1,
- ///
- CLEAR_FRAME = 2,
- ///
- DRAW_FRAME = 4,
- ///
- SELECTION = 8,
- ///
- CURSOR_PAR = 16,
- ///
- FULL = 32,
- ///
- INIT = 64
- };
///
enum DrawFrame {
///
ALWAYS
};
///
- InsetText(BufferParams const &);
- ///
- explicit
- InsetText(InsetText const &, bool same_id = false);
- ///
- ~InsetText();
- ///
- Inset * clone(Buffer const &, bool same_id = false) const;
- ///
- InsetText & operator=(InsetText const & it);
- ///
- void clear();
+ explicit InsetText(BufferParams const &);
///
- void read(Buffer const *, LyXLex &);
+ explicit InsetText();
///
- void write(Buffer const *, std::ostream &) const;
+ InsetText(InsetText const &);
///
- int ascent(BufferView *, LyXFont const &) const;
+ virtual std::auto_ptr<InsetBase> clone() const;
///
- int descent(BufferView *, LyXFont const &) const;
+ void operator=(InsetText const & it);
+ /// empty inset to empty par, or just mark as erased
+ void clear(bool just_mark_erased);
///
- int width(BufferView *, LyXFont const & f) const;
+ void read(Buffer const & buf, LyXLex & lex);
///
- int textWidth(BufferView *, bool fordraw = false) const;
+ void write(Buffer const & buf, std::ostream & os) const;
///
- void draw(BufferView *, LyXFont const &, int , float &, bool) const;
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
///
- void update(BufferView *, LyXFont const &, bool = false);
+ void draw(PainterInfo & pi, int x, int y) const;
+ /// draw inset selection
+ void drawSelection(PainterInfo & pi, int x, int y) const;
///
- void setUpdateStatus(BufferView *, int what) const;
- ///
- string const editMessage() const;
- ///
- void edit(BufferView *, int, int, mouse_button::state);
- ///
- void edit(BufferView *, bool front = true);
+ std::string const editMessage() const;
///
bool isTextInset() const { return true; }
///
- bool doClearArea() const;
- ///
- void insetUnlock(BufferView *);
- ///
- bool lockInsetInInset(BufferView *, UpdatableInset *);
- ///
- bool unlockInsetInInset(BufferView *,
- UpdatableInset *, bool lr = false);
- ///
- bool updateInsetInInset(BufferView *, Inset *);
- ///
- bool insetButtonRelease(BufferView *, int, int, mouse_button::state);
+ int latex(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- void insetButtonPress(BufferView *, int, int, mouse_button::state);
+ int plaintext(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- void insetMotionNotify(BufferView *, int, int, mouse_button::state);
+ int linuxdoc(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- UpdatableInset::RESULT localDispatch(BufferView *,
- kb_action, string const &);
- ///
- int latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
- ///
- int ascii(Buffer const *, std::ostream &, int linelen) const;
- ///
- int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
- ///
- int docbook(Buffer const *, std::ostream &, bool mixcont) const ;
+ int docbook(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
void validate(LaTeXFeatures & features) const;
///
- Inset::Code lyxCode() const { return Inset::TEXT_CODE; }
- ///
- void getCursorPos(BufferView *, int & x, int & y) const;
- ///
- int insetInInsetY() const;
- ///
- void toggleInsetCursor(BufferView *);
- ///
- void showInsetCursor(BufferView *, bool show = true);
- ///
- void hideInsetCursor(BufferView *);
- ///
- void fitInsetCursor(BufferView *) const;
- ///
- bool insertInset(BufferView *, Inset *);
- ///
- bool insetAllowed(Inset::Code) const;
- ///
- UpdatableInset * getLockingInset() const;
- ///
- UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
+ InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
+ /// FIXME, document
+ void getCursorPos(LCursor const & cur, int & x, int & y) const;
///
void setFont(BufferView *, LyXFont const &,
bool toggleall = false,
bool selectall = false);
///
- int getMaxWidth(BufferView *, UpdatableInset const *) const;
- ///
- void init(InsetText const * ins = 0, bool same_id = false);
- ///
- void writeParagraphData(Buffer const *, std::ostream &) const;
- ///
- void setParagraphData(Paragraph *, bool same_id = false);
- ///
- void setText(string const &, LyXFont const &);
+ void setText(std::string const &, LyXFont const &);
///
void setAutoBreakRows(bool);
///
- bool getAutoBreakRows() const { return autoBreakRows; }
- ///
- void setDrawFrame(BufferView *, DrawFrame);
+ bool getAutoBreakRows() const { return autoBreakRows_; }
///
- void setFrameColor(BufferView *, LColor::color);
+ void setDrawFrame(DrawFrame);
///
- LyXText * getLyXText(BufferView const *,
- bool const recursive = false) const;
+ LColor_color frameColor() const;
///
- void deleteLyXText(BufferView *, bool recursive = true) const;
+ void setFrameColor(LColor_color);
///
- void resizeLyXText(BufferView *, bool force = false) const;
+ void setViewCache(BufferView const * bv) const;
///
bool showInsetDialog(BufferView *) const;
+ /// Appends \c list with all labels found within this inset.
+ void getLabelList(Buffer const &, std::vector<std::string> & list) const;
///
- std::vector<string> const getLabelList() const;
- ///
- bool nodraw() const;
- ///
- int scroll(bool recursive = true) const;
- ///
- void scroll(BufferView * bv, float sx) const {
- UpdatableInset::scroll(bv, sx);
- }
- ///
- void scroll(BufferView * bv, int offset) const {
- UpdatableInset::scroll(bv, offset);
- }
- ///
- void selectAll(BufferView * bv);
- ///
- void clearSelection(BufferView * bv);
- ///
- Paragraph * getParFromID(int id) const;
- ///
- Inset * getInsetFromID(int id) const;
- ///
- Paragraph * firstParagraph() const;
- ///
- Paragraph * getFirstParagraph(int) const;
- ///
- LyXCursor const & cursor(BufferView *) const;
- ///
- Paragraph * paragraph() const;
- ///
- void paragraph(Paragraph *);
- ///
- bool allowSpellcheck() { return true; }
+ LyXText * getText(int) const;
///
- string const selectNextWordToSpellcheck(BufferView *,
- float & value) const;
- void selectSelectedWord(BufferView *);
- ///
- void toggleSelection(BufferView *, bool kill_selection);
- ///
- bool searchForward(BufferView *, string const &,
- bool = true, bool = false);
- ///
- bool searchBackward(BufferView *, string const &,
- bool = true, bool = false);
- ///
- bool checkInsertChar(LyXFont &);
- ///
- void getDrawFont(LyXFont &) const;
- ///
- void appendParagraphs(BufferParams const & bparams, Paragraph *);
- ///
- void addPreview(grfx::PreviewLoader &) const;
+ bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
- //
- // Public structures and variables
- ///
- mutable int need_update;
+ /// mark as erased for change tracking
+ void markErased() { clear(true); }
+ /**
+ * Mark as new. Used when pasting in tabular, and adding rows
+ * or columns. Note that pasting will ensure that tracking already
+ * happens, and this just resets the changes for the copied text,
+ * whereas for row/col add, we need to start tracking changes
+ * for the (empty) paragraph contained.
+ */
+ void markNew(bool track_changes = false);
-protected:
- ///
- void updateLocal(BufferView *, int what, bool mark_dirty) const;
- /// set parameters for an initial lock of this inset
- void lockInset(BufferView *);
- /// lock an inset inside this one
- void lockInset(BufferView *, UpdatableInset *);
- ///
- mutable int drawTextXOffset;
- ///
- mutable int drawTextYOffset;
- ///
- bool autoBreakRows;
- ///
- DrawFrame drawFrame_;
- ///
- LColor::color frame_color;
+ /// append text onto the existing text
+ void appendParagraphs(Buffer * bp, ParagraphList &);
-private:
///
- struct InnerCache {
- ///
- InnerCache(boost::shared_ptr<LyXText>);
- ///
- boost::shared_ptr<LyXText> text;
- ///
- bool remove;
- };
- ///
- typedef std::map<BufferView *, InnerCache> Cache;
- ///
- typedef Cache::value_type value_type;
- ///
- int beginningOfMainBody(Paragraph * par) const;
- ///
- UpdatableInset::RESULT moveRight(BufferView *,
- bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveLeft(BufferView *,
- bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveRightIntern(BufferView *, bool front,
- bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveLeftIntern(BufferView *, bool front,
- bool activate_inset = true,
- bool selecting = false);
+ void addPreview(lyx::graphics::PreviewLoader &) const;
///
- UpdatableInset::RESULT moveUp(BufferView *);
- ///
- UpdatableInset::RESULT moveDown(BufferView *);
- ///
- void setCharFont(Buffer const *, int pos, LyXFont const & font);
- ///
- bool checkAndActivateInset(BufferView * bv, bool front);
- ///
- bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
- mouse_button::state button = mouse_button::none);
- ///
- void removeNewlines();
+ void edit(LCursor & cur, bool left);
///
- int cx(BufferView *) const;
- ///
- int cix(BufferView *) const;
- ///
- int cy(BufferView *) const;
- ///
- int ciy(BufferView *) const;
- ///
- lyx::pos_type cpos(BufferView *) const;
- ///
- Paragraph * cpar(BufferView *) const;
- ///
- bool cboundary(BufferView *) const;
- ///
- Row * crow(BufferView *) const;
- ///
- void drawFrame(Painter &, bool cleared) const;
- ///
- void clearFrame(Painter &, bool cleared) const;
- ///
- void clearInset(BufferView *, int baseline, bool & cleared) const;
- ///
- void saveLyXTextState(LyXText *) const;
- ///
- void restoreLyXTextState(BufferView *, LyXText *) const;
- ///
- void reinitLyXText() const;
- ///
- void collapseParagraphs(BufferView *) const;
+ InsetBase * editXY(LCursor & cur, int x, int y);
- /* Private structures and variables */
- ///
- Paragraph * par;
- ///
- mutable bool locked;
- ///
- mutable int insetAscent;
+ /// number of cells in this inset
+ size_t nargs() const { return 1; }
///
- mutable int insetDescent;
+ ParagraphList & paragraphs();
///
- mutable int insetWidth;
+ ParagraphList const & paragraphs() const;
///
- mutable int top_y;
+ bool insetAllowed(Code) const { return true; }
///
- Paragraph * inset_par;
- ///
- lyx::pos_type inset_pos;
- ///
- bool inset_boundary;
- ///
- mutable int inset_x;
- ///
- mutable int inset_y;
- ///
- mutable int old_max_width;
- ///
- bool no_selection;
- ///
- mutable float xpos;
- ///
- UpdatableInset * the_locking_inset;
+ bool allowSpellCheck() const { return true; }
+
+protected:
///
- mutable Paragraph * old_par;
- /// The cache.
- mutable Cache cache;
+ void priv_dispatch(LCursor & cur, FuncRequest & cmd);
+private:
///
- mutable int last_drawn_width;
+ void updateLocal(LCursor &);
///
- mutable bool frame_is_visible;
+ void init();
+ // If the inset is empty set the language of the current font to the
+ // language to the surronding text (if different).
+ void sanitizeEmptyText(BufferView &);
///
- mutable BufferView * cached_bview;
+ void setCharFont(Buffer const &, int pos, LyXFont const & font);
///
- mutable boost::shared_ptr<LyXText> cached_text;
+ void removeNewlines();
///
- struct save_state {
- Paragraph * lpar;
- Paragraph * selstartpar;
- Paragraph * selendpar;
- lyx::pos_type pos;
- lyx::pos_type selstartpos;
- lyx::pos_type selendpos;
- bool boundary;
- bool selstartboundary;
- bool selendboundary;
- bool selection;
- bool mark_set;
- bool refresh;
- };
+ void drawFrame(Painter &, int x, int y) const;
///
- mutable save_state sstate;
+ void clearInset(Painter &, int x, int y) const;
///
- // this is needed globally so we know that we're using it actually and
- // so the LyXText-Cache is not erased until used!
- mutable LyXText * lt;
- ///
- // to remember old painted frame dimensions to clear it on the right spot!
+ bool autoBreakRows_;
///
- mutable int frame_x;
- mutable int frame_y;
- mutable int frame_w;
- mutable int frame_h;
+ DrawFrame drawFrame_;
+ /** We store the LColor::color value as an int to get LColor.h out
+ * of the header file.
+ */
+ int frame_color_;
///
- bool in_update; /* as update is not reentrant! */
- mutable BufferView * do_resize;
- mutable bool do_reinit;
- mutable bool in_insetAllowed;
+ mutable lyx::par_type old_par;
+public:
///
- // these are used to check for mouse movement in Motion selection code
+ mutable LyXText text_;
///
- int mouse_x;
- int mouse_y;
+ mutable LyXFont font_;
};
#endif
projects / lyx.git / blobdiff