// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995-2001 the LyX Team.
+/**
+ * \file inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
+ *
+ * Full author contact details are available in file CREDITS
+ */
#ifndef INSET_H
#define INSET_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "LString.h"
+#include "LColor.h"
+#include "insetbase.h"
+#include "support/types.h"
#include <vector>
-#include "LString.h"
-#include <X11/Xlib.h>
-#include "commandtags.h"
class LyXFont;
-class BufferView;
+class Dimension;
class Buffer;
class Painter;
+class LatexRunParams;
class LyXText;
class LyXLex;
+class Paragraph;
+class ParagraphList;
+class LyXCursor;
+class FuncRequest;
+class WordLangTuple;
struct LaTeXFeatures;
+namespace grfx {
+ class PreviewLoader;
+}
/// Insets
-class Inset {
+class Inset : public InsetBase {
public:
/** This is not quite the correct place for this enum. I think
the correct would be to let each subclass of Inset declare
///
LABEL_CODE, // 10
///
- IGNORE_CODE,
+ NOTE_CODE,
///
ACCENT_CODE,
///
///
PARENT_CODE,
///
+ BIBITEM_CODE,
+ ///
BIBTEX_CODE,
///
TEXT_CODE,
///
FLOAT_CODE,
///
+ WRAP_CODE,
+ ///
MINIPAGE_CODE,
///
+ SPACE_CODE,
+ ///
SPECIALCHAR_CODE, // 25
///
TABULAR_CODE,
///
EXTERNAL_CODE,
+#if 0
///
THEOREM_CODE,
+#endif
///
CAPTION_CODE,
///
///
CITE_CODE,
///
- FLOAT_LIST_CODE
+ FLOAT_LIST_CODE,
+ ///
+ INDEX_PRINT_CODE,
+ ///
+ OPTARG_CODE,
+ ///
+ ENVIRONMENT_CODE,
+ ///
+ HFILL_CODE,
+ ///
+ NEWLINE_CODE
};
///
///
HIGHLY_EDITABLE
};
-
- ///
- Inset() : top_x(0), top_baseline(0), scx(0), owner_(0) {}
- /// Virtual base destructor
- virtual ~Inset() {}
+
///
- virtual int ascent(BufferView *, LyXFont const &) const = 0;
+ typedef dispatch_result RESULT;
+
///
- virtual int descent(BufferView *, LyXFont const &) const = 0;
+ Inset();
///
- virtual int width(BufferView *, LyXFont const &) const = 0;
+ Inset(Inset const & in, bool same_id = false);
///
- 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 void dimension(BufferView *, LyXFont const &, Dimension &) const = 0;
///
- virtual LyXFont const ConvertFont(LyXFont const & font) const;
- /// what appears in the minibuffer when opening
- virtual string const EditMessage() const;
+ int ascent(BufferView *, LyXFont const &) const;
///
- virtual void Edit(BufferView *, int x, int y, unsigned int button);
+ int descent(BufferView *, LyXFont const &) const;
///
- 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) {}
+ int width(BufferView *, LyXFont const &) const;
///
- virtual bool IsTextInset() const { return false; }
+ virtual void draw(BufferView *, LyXFont const &, int baseline, float & x) const = 0;
+ /// update the inset representation
+ virtual void update(BufferView *, bool = false)
+ {}
+ /// what appears in the minibuffer when opening
+ virtual string const editMessage() const;
///
- virtual bool doClearArea() const { return true; }
+ virtual EDITABLE editable() const;
///
- virtual bool AutoDelete() const;
+ virtual bool isTextInset() const { return false; }
+ /// return true if the inset should be removed automatically
+ virtual bool autoDelete() const;
+ /// returns true the inset can hold an inset of given type
+ virtual bool insetAllowed(Inset::Code) const { return false; }
+ /// wrapper around the above
+ bool insetAllowed(Inset * in) const;
///
- virtual void Write(Buffer const *, std::ostream &) const = 0;
+ virtual void write(Buffer const *, std::ostream &) const = 0;
///
- virtual void Read(Buffer const *, LyXLex & lex) = 0;
- /** returns the number of rows (\n's) of generated tex code.
- 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 void read(Buffer const *, LyXLex & lex) = 0;
+ /// returns the number of rows (\n's) of generated tex code.
+ virtual int latex(Buffer const *, std::ostream &,
+ LatexRunParams const &) const = 0;
///
- virtual int Ascii(Buffer const *,
+ virtual int ascii(Buffer const *,
std::ostream &, int linelen = 0) const = 0;
///
- virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
+ virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
///
- virtual int DocBook(Buffer const *, std::ostream &) const = 0;
+ virtual int docbook(Buffer const *, std::ostream &, bool) const = 0;
/// Updates needed features for this inset.
- virtual void Validate(LaTeXFeatures & features) const;
- ///
- virtual bool Deletable() const;
-
+ virtual void validate(LaTeXFeatures & features) const;
+
/// returns LyX code associated with the inset. Used for TOC, ...)
- virtual Inset::Code LyxCode() const { return NO_CODE; }
-
+ virtual Inset::Code lyxCode() const { return NO_CODE; }
+
virtual std::vector<string> const getLabelList() const {
return std::vector<string>();
}
///
- virtual Inset * Clone(Buffer const &) const = 0;
-
+ virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
+
/// returns true to override begin and end inset in file
- virtual bool DirectWrite() const;
+ virtual bool directWrite() const;
/// Returns true if the inset should be centered alone
virtual bool display() const { return false; }
///
virtual bool needFullRow() const { return false; }
///
- virtual bool InsertInsetAllowed(Inset *) const { return false; }
+ void setInsetName(string const & s) { name_ = s; }
///
- void setInsetName(string const & s) { name = s; }
- ///
- string const getInsetName() const { return name; }
+ string const & getInsetName() const { return name_; }
///
void setOwner(Inset * inset) { owner_ = inset; }
///
Inset * owner() const { return owner_; }
///
+ void parOwner(Paragraph * par) { par_owner_ = par; }
+ ///
+ Paragraph * parOwner() const { return par_owner_; }
+ ///
+ void setBackgroundColor(LColor::color);
+ ///
+ LColor::color backgroundColor() const;
+ ///
int x() const { return top_x; }
///
int y() const { return top_baseline; }
return 0;
}
+ /// try to get a inset pointer from it's id if we have
+ /// an inset to give back!
+ virtual Inset * getInsetFromID(int /*id*/) const { return 0; }
+ /// if this insets owns paragraphs (f.ex. InsetText) then it
+ /// should return it's very first one!
+ virtual ParagraphList * getParagraphs(int /*num*/) const { return 0; }
+ ///
+ virtual bool haveParagraphs() const {
+ return false;
+ }
+
+ /// return the cursor if we own one otherwise giv'em just the
+ /// BufferView cursor to work with.
+ virtual LyXCursor const & cursor(BufferView * bview) const;
+ /// id functions
+ int id() const;
+ ///
+ void id(int id_arg);
+
+ /// used to toggle insets
+ // is the inset open?
+ virtual bool isOpen() const { return false; }
+ /// open the inset
+ virtual void open(BufferView *) {}
+ /// close the inset
+ virtual void close(BufferView *) const {}
+ /// check if the font of the char we want inserting is correct
+ /// and modify it if it is not.
+ virtual bool checkInsertChar(LyXFont &);
+ /// we need this here because collapsed insets are only EDITABLE
+ virtual void setFont(BufferView *, LyXFont const &,
+ bool toggleall = false, bool selectall = false);
+ ///
+ // needed for spellchecking text
+ ///
+ virtual bool allowSpellcheck() const { return false; }
+
+ // should this inset be handled like a normal charater
+ virtual bool isChar() const { return false; }
+ // is this equivalent to a letter?
+ virtual bool isLetter() const { return false; }
+ // is this equivalent to a space (which is BTW different from
+ // a line separator)?
+ virtual bool isSpace() const { return false; }
+ // should we break lines after this inset?
+ virtual bool isLineSeparator() const { return false; }
+ // if this inset has paragraphs should they be output all as default
+ // paragraphs with "Standard" layout?
+ virtual bool forceDefaultParagraphs(Inset const *) const;
+ /** returns true if, when outputing LaTeX, font changes should
+ be closed before generating this inset. This is needed for
+ insets that may contain several paragraphs */
+ virtual bool noFontChange() const { return false; }
+ //
+ virtual void getDrawFont(LyXFont &) const {}
+ /* needed for widths which are % of something
+ returns the value of \textwidth in this inset. Most of the
+ time this is the width of the workarea, but if there is a
+ minipage somewhere, it will be the width of this minipage */
+ virtual int latexTextWidth(BufferView *) const;
+
+ /// mark the inset contents as erased (for change tracking)
+ virtual void markErased() {}
+
+ /** Adds a LaTeX snippet to the Preview Loader for transformation
+ * into a bitmap image. Does not start the laoding process.
+ *
+ * Most insets have no interest in this capability, so the method
+ * defaults to empty.
+ */
+ virtual void addPreview(grfx::PreviewLoader &) const {}
+
+ /** Find the PreviewLoader, add a LaTeX snippet to it and
+ * start the loading process.
+ *
+ * Most insets have no interest in this capability, so the method
+ * defaults to empty.
+ */
+ virtual void generatePreview() const {}
+
protected:
///
mutable int top_x;
mutable int top_baseline;
///
mutable int scx;
+ ///
+ unsigned int id_;
+ ///
+ static unsigned int inset_id;
+
private:
///
Inset * owner_;
+ /// the paragraph in which this inset has been inserted
+ Paragraph * par_owner_;
///
- string name;
+ string name_;
+ ///
+ LColor::color background_color_;
};
-// Updatable Insets. These insets can be locked and receive
-// directly user interaction. Currently used only for mathed.
-// Note that all pure methods from Inset class are pure here too.
-// [Alejandro 080596]
+inline
+bool Inset::insetAllowed(Inset * in) const
+{
+ return insetAllowed(in->lyxCode());
+}
-/** 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 {
-public:
- /** Dispatch result codes
- Now that nested updatable insets are allowed, the local dispatch
- becomes a bit complex, just two possible results (boolean)
- 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,
- DISPATCHED_NOUPDATE,
- FINISHED
- };
-
- /// To convert old binary dispatch results
- RESULT DISPATCH_RESULT(bool b) {
- return b ? DISPATCHED : FINISHED;
- }
- ///
- UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
+inline
+bool Inset::checkInsertChar(LyXFont &)
+{
+ return false;
+}
- ///
- virtual EDITABLE Editable() const;
-
- /// may call ToggleLockedInsetCursor
- virtual void ToggleInsetCursor(BufferView *);
- ///
- 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 InsetButtonRelease(BufferView *,
- int x, int y, int button);
- ///
- virtual void InsetKeyPress(XKeyEvent * ev);
- ///
- virtual void InsetMotionNotify(BufferView *, int x, int y, int state);
- ///
- virtual void InsetUnlock(BufferView *);
- ///
- virtual void Edit(BufferView *, int x, int y, unsigned int button);
- ///
- virtual void draw(BufferView *, LyXFont const &,
- int baseline, float & x, bool cleared) const;
- ///
- virtual void SetFont(BufferView *, LyXFont const &,
- bool toggleall = false, bool selectall = false);
- ///
- virtual bool InsertInset(BufferView *, Inset *) { return false; }
- ///
- virtual bool InsertInsetAllowed(Inset *) const { return true; }
- ///
- virtual UpdatableInset * GetLockingInset() { return this; }
- ///
- 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 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 *, kb_action, string const &);
- ///
- bool isCursorVisible() const { return cursor_visible_; }
- ///
- virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) 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 nodraw(bool b) {
- block_drawing_ = b;
- }
- ///
- virtual bool nodraw() const {
- return block_drawing_;
- }
+/**
+ * returns true if pointer argument is valid
+ * and points to an editable inset
+ */
+inline bool isEditableInset(Inset const * i)
+{
+ return i && i->editable();
+}
-protected:
- ///
- void toggleCursorVisible() const {
- cursor_visible_ = !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;
+/**
+ * returns true if pointer argument is valid
+ * and points to a highly editable inset
+ */
+inline bool isHighlyEditableInset(Inset const * i)
+{
+ return i && i->editable() == Inset::HIGHLY_EDITABLE;
+}
-private:
- ///
- mutable bool cursor_visible_;
- ///
- bool block_drawing_;
-};
#endif