*
* LyX, The Document Processor
*
- * Copyright 1995 Matthias Ettrich
* Copyright 1995-2000 the LyX Team.
*
* ====================================================== */
#pragma interface
#endif
-#include "gettext.h"
+#include <vector>
+
+#include <X11/Xlib.h>
+
#include "lyxfont.h"
#include "lyxlex.h"
+#include "commandtags.h"
-using std::ostream;
-
-class Painter;
-class Buffer;
class BufferView;
+class Buffer;
+class Painter;
+class LyXText;
struct LaTeXFeatures;
///
TOC_CODE, // do these insets really need a code? (ale)
///
- LOF_CODE,
- ///
- LOT_CODE,
- ///
- LOA_CODE,
- ///
QUOTE_CODE,
///
MARK_CODE,
///
- REF_CODE,
+ REF_CODE, // 5
///
URL_CODE,
///
///
ENDING_CODE,
///
- LABEL_CODE,
+ LABEL_CODE, // 10
///
IGNORE_CODE,
///
///
INDEX_CODE,
///
- INCLUDE_CODE,
+ INCLUDE_CODE, // 15
///
GRAPHICS_CODE,
///
///
TEXT_CODE,
///
+ ERT_CODE, // 20
+ ///
FOOT_CODE,
///
MARGIN_CODE,
///
- SPECIALCHAR_CODE
+ FLOAT_CODE,
+ ///
+ MINIPAGE_CODE,
+ ///
+ SPECIALCHAR_CODE, // 25
+ ///
+ TABULAR_CODE,
+ ///
+ EXTERNAL_CODE,
+ ///
+ THEOREM_CODE,
+ ///
+ CAPTION_CODE,
+ ///
+ MATHMACRO_CODE, // 30
+ ///
+ ERROR_CODE,
+ ///
+ CITE_CODE,
+ ///
+ FLOAT_LIST_CODE
};
- enum EDITABLE {
- NOT_EDITABLE = 0,
- IS_EDITABLE,
- HIGHLY_EDITABLE
+ ///
+ enum {
+ ///
+ TEXT_TO_INSET_OFFSET = 2
};
///
+ enum EDITABLE {
+ ///
+ NOT_EDITABLE = 0,
+ ///
+ IS_EDITABLE,
+ ///
+ HIGHLY_EDITABLE
+ };
+
+ ///
+ Inset() : top_x(0), top_baseline(0), scx(0), owner_(0) {}
+ /// Virtual base destructor
virtual ~Inset() {}
///
- virtual int ascent(Painter &, LyXFont const &) const = 0;
+ virtual int ascent(BufferView *, LyXFont const &) const = 0;
///
- virtual int descent(Painter &, LyXFont const &) const = 0;
+ virtual int descent(BufferView *, LyXFont const &) const = 0;
///
- virtual int width(Painter &, LyXFont const &) const = 0;
+ virtual int width(BufferView *, LyXFont const &) const = 0;
///
- virtual void draw(Painter &, LyXFont const &,
- int baseline, float & x) const = 0;
+ virtual void draw(BufferView *, LyXFont const &,
+ int baseline, float & x, bool cleared) const = 0;
+ /// update the inset representation
+ virtual void update(BufferView *, LyXFont const &, bool = false)
+ {}
///
- virtual LyXFont ConvertFont(LyXFont font);
+ virtual LyXFont const ConvertFont(LyXFont const & font) const;
/// what appears in the minibuffer when opening
- virtual const char * EditMessage() const {return _("Opened inset");}
+ virtual string const EditMessage() const;
///
virtual void Edit(BufferView *, int x, int y, unsigned int button);
///
virtual EDITABLE Editable() const;
+ /// This is called when the user clicks inside an inset
+ virtual void InsetButtonPress(BufferView *, int, int, int) {}
+ /// This is called when the user releases the button inside an inset
+ virtual void InsetButtonRelease(BufferView *, int, int, int) {}
+ /// This is caleld when the user moves the mouse inside an inset
+ virtual void InsetMotionNotify(BufferView *, int , int , int) {}
+ ///
+ virtual bool IsTextInset() const { return false; }
+ ///
+ virtual bool doClearArea() const { return true; }
///
virtual bool AutoDelete() const;
///
- virtual void Write(ostream &) const = 0;
+ virtual void Write(Buffer const *, std::ostream &) const = 0;
///
- virtual void Read(LyXLex & lex) = 0;
+ virtual void Read(Buffer const *, LyXLex & lex) = 0;
/** returns the number of rows (\n's) of generated tex code.
- fragile != 0 means, that the inset should take care about
- fragile commands by adding a \protect before.
- If the freee_spc (freespacing) variable is set, then this inset
- is in a free-spacing paragraph.
- */
- virtual int Latex(ostream &, signed char fragile,
+ fragile == true means, that the inset should take care about
+ fragile commands by adding a \protect before.
+ If the free_spc (freespacing) variable is set, then this inset
+ is in a free-spacing paragraph.
+ */
+ virtual int Latex(Buffer const *, std::ostream &, bool fragile,
bool free_spc) const = 0;
-
///
- virtual int Linuxdoc(ostream &) const = 0;
+ virtual int Ascii(Buffer const *,
+ std::ostream &, int linelen = 0) const = 0;
+ ///
+ virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
///
- virtual int DocBook(ostream &) const = 0;
+ virtual int DocBook(Buffer const *, std::ostream &) const = 0;
/// Updates needed features for this inset.
virtual void Validate(LaTeXFeatures & features) const;
///
virtual bool Deletable() const;
-
+
/// returns LyX code associated with the inset. Used for TOC, ...)
- virtual Inset::Code LyxCode() const = 0;
-
- /// Get the label that appears at screen
- virtual string getLabel(int) const {
- return string();
+ virtual Inset::Code LyxCode() const { return NO_CODE; }
+
+ virtual std::vector<string> const getLabelList() const {
+ return std::vector<string>();
}
///
- virtual Inset * Clone() const = 0;
-
+ virtual Inset * Clone(Buffer const &) const = 0;
+
/// returns true to override begin and end inset in file
virtual bool DirectWrite() const;
/// Returns true if the inset should be centered alone
- virtual bool display() const { return false; }
+ virtual bool display() const { return false; }
/// Changes the display state of the inset
- virtual void display(bool) {}
+ virtual void display(bool) {}
+ ///
+ /// returns true if this inset needs a row on it's own
+ ///
+ virtual bool needFullRow() const { return false; }
+ ///
+ virtual bool InsertInsetAllowed(Inset *) const { return false; }
+ ///
+ void setInsetName(string const & s) { name = s; }
+ ///
+ string const getInsetName() const { return name; }
+ ///
+ void setOwner(Inset * inset) { owner_ = inset; }
///
- virtual int GetNumberOfLabels() const {
+ Inset * owner() const { return owner_; }
+ ///
+ int x() const { return top_x; }
+ ///
+ int y() const { return top_baseline; }
+ //
+ // because we could have fake text insets and have to call this
+ // inside them without cast!!!
+ ///
+ virtual LyXText * getLyXText(BufferView const *,
+ bool const recursive = false) const;
+ ///
+ virtual void deleteLyXText(BufferView *, bool = true) const {}
+ ///
+ virtual void resizeLyXText(BufferView *) const {}
+ /// returns the actuall scroll-value
+ virtual int scroll(bool recursive=true) const {
+ if (!recursive || !owner_)
+ return scx;
return 0;
}
- ///
- virtual void init(BufferView *) {}
+protected:
+ ///
+ mutable int top_x;
+ ///
+ mutable int top_baseline;
+ ///
+ mutable int scx;
+private:
+ ///
+ Inset * owner_;
+ ///
+ string name;
};
// [Alejandro 080596]
/** Extracted from Matthias notes:
- *
- * An inset can simple call LockInset in it's edit call and *ONLY*
- * in it's edit call.
- *
- * Unlocking is either done by LyX or the inset itself with a
- * UnlockInset-call
- *
- * During the lock, all button and keyboard events will be modified
- * and send to the inset through the following inset-features. Note that
- * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
- * to contain the code for restoring the menus and things like this.
- *
- * If a inset wishes any redraw and/or update it just has to call
- * UpdateInset(this).
- *
- * It's is completly irrelevant, where the inset is. UpdateInset will
- * find it in any paragraph in any buffer.
- * Of course the_locking_inset and the insets in the current paragraph/buffer
- * are checked first, so no performance problem should occur.
- */
-class UpdatableInset: public Inset {
+ *
+ * An inset can simple call LockInset in it's edit call and *ONLY*
+ * in it's edit call.
+ *
+ * Unlocking is either done by LyX or the inset itself with a
+ * UnlockInset-call
+ *
+ * During the lock, all button and keyboard events will be modified
+ * and send to the inset through the following inset-features. Note that
+ * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
+ * to contain the code for restoring the menus and things like this.
+ *
+ * If a inset wishes any redraw and/or update it just has to call
+ * UpdateInset(this).
+ *
+ * It's is completly irrelevant, where the inset is. UpdateInset will
+ * find it in any paragraph in any buffer.
+ * Of course the_locking_inset and the insets in the current paragraph/buffer
+ * are checked first, so no performance problem should occur.
+ */
+class UpdatableInset : public Inset {
public:
/** Dispatch result codes
Now that nested updatable insets are allowed, the local dispatch
are not enough.
DISPATCHED = the inset catched the action
+ DISPATCHED_NOUPDATE = the inset catched the action and no update
+ is needed here to redraw the inset
FINISHED = the inset must be unlocked as a result
of the action
UNDISPATCHED = the action was not catched, it should be
dispatched by lower level insets
*/
enum RESULT {
- UNDISPATCHED = 0,
- DISPATCHED,
- FINISHED
+ UNDISPATCHED = 0,
+ DISPATCHED,
+ DISPATCHED_NOUPDATE,
+ FINISHED
};
/// To convert old binary dispatch results
}
///
- UpdatableInset() {
- scx = mx_scx = 0;
- owner_ = 0;
- }
- ///
- //virtual ~UpdatableInset() {}
+ UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
+
///
virtual EDITABLE Editable() const;
-
+
/// may call ToggleLockedInsetCursor
virtual void ToggleInsetCursor(BufferView *);
///
- virtual void GetCursorPos(int &, int &) const {}
+ virtual void ShowInsetCursor(BufferView *, bool show = true);
+ ///
+ virtual void HideInsetCursor(BufferView *);
+ ///
+ virtual void GetCursorPos(BufferView *, int &, int &) const {}
///
virtual void InsetButtonPress(BufferView *, int x, int y, int button);
///
///
virtual void Edit(BufferView *, int x, int y, unsigned int button);
///
- virtual void draw(Painter &, LyXFont const &,
- int baseline, float & x) const;
+ virtual void draw(BufferView *, LyXFont const &,
+ int baseline, float & x, bool cleared) const;
///
virtual void SetFont(BufferView *, LyXFont const &,
bool toggleall = false);
///
virtual bool InsertInset(BufferView *, Inset *) { return false; }
///
+ virtual bool InsertInsetAllowed(Inset *) const { return true; }
+ ///
virtual UpdatableInset * GetLockingInset() { return this; }
///
- virtual int InsetInInsetY() { return 0; }
+ virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
+ { return (c == LyxCode()) ? this : 0; }
+ ///
+ virtual unsigned int InsetInInsetY() { return 0; }
///
virtual bool UpdateInsetInInset(BufferView *, Inset *)
{ return false; }
///
- virtual bool UnlockInsetInInset(BufferView *, Inset *,
+ virtual bool LockInsetInInset(BufferView *, UpdatableInset *)
+ { return false; }
+ ///
+ virtual bool UnlockInsetInInset(BufferView *, UpdatableInset *,
bool /*lr*/ = false)
{ return false; }
/// An updatable inset could handle lyx editing commands
- virtual RESULT LocalDispatch(BufferView *, int, string const &);
+ virtual RESULT LocalDispatch(BufferView *, kb_action, string const &);
+ ///
+ bool isCursorVisible() const { return cursor_visible_; }
///
- virtual bool isCursorVisible() const { return cursor_visible; }
+ virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
///
- virtual int getMaxWidth(Painter & pain) const;
+ int scroll(bool recursive=true) const {
+ // We need this method to not clobber the real method in Inset
+ return Inset::scroll(recursive);
+ }
+ ///
+ virtual bool ShowInsetDialog(BufferView *) const { return false; }
///
- virtual void setOwner(UpdatableInset * inset) { owner_ = inset; }
+ virtual void nodraw(bool b) {
+ block_drawing_ = b;
+ }
///
- virtual UpdatableInset * owner() { return owner_; }
+ virtual bool nodraw() const {
+ return block_drawing_;
+ }
protected:
///
- // virtual void UpdateLocal(bool flag=true);
+ void toggleCursorVisible() const {
+ cursor_visible_ = !cursor_visible_;
+ }
///
- mutable int top_x;
- mutable int top_baseline;
- mutable bool cursor_visible;
+ void setCursorVisible(bool b) const {
+ cursor_visible_ = b;
+ }
+ /// scrolls to absolute position in bufferview-workwidth * sx units
+ void scroll(BufferView *, float sx) const;
+ /// scrolls offset pixels
+ void scroll(BufferView *, int offset) const;
private:
///
- int mx_scx;
- mutable int scx;
+ mutable bool cursor_visible_;
///
- UpdatableInset * owner_;
-
+ bool block_drawing_;
};
#endif
projects / lyx.git / blobdiff