#ifndef INSETBASE_H
#define INSETBASE_H
+#include "changes.h"
+#include "dimension.h"
+
+#include "support/docstream.h"
+
#include <memory>
-#include <string>
#include <vector>
+namespace lyx {
+
class Buffer;
class BufferView;
class CursorSlice;
class FuncRequest;
class FuncStatus;
+class InsetMath;
+class InsetText;
class LaTeXFeatures;
class LCursor;
class LyXLex;
class LyXText;
-class MathInset;
class MetricsInfo;
class Dimension;
class PainterInfo;
class OutputParams;
+class TocList;
-namespace lyx { namespace graphics { class PreviewLoader; } }
+namespace graphics { class PreviewLoader; }
/// Common base class to all insets
std::auto_ptr<InsetBase> clone() const;
/// identification as math inset
- virtual MathInset * asMathInset() { return 0; }
+ virtual InsetMath * asInsetMath() { return 0; }
/// true for 'math' math inset, but not for e.g. mbox
virtual bool inMathed() const { return false; }
virtual InsetBase * editXY(LCursor & cur, int x, int y);
/// compute the size of the object returned in dim
- virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
+ /// \retval true if metrics changed.
+ virtual bool metrics(MetricsInfo & mi, Dimension & dim) const = 0;
/// draw inset and update (xo, yo)-cache
virtual void draw(PainterInfo & pi, int x, int y) const = 0;
/// draw inset selection if necessary
virtual bool editing(BufferView * bv) const;
///
virtual bool showInsetDialog(BufferView *) const { return false; }
+
+ /// draw inset decoration if necessary.
+ /// This can use \c drawMarkers() for example.
+ virtual void drawDecoration(PainterInfo &, int, int) const {}
/// draw four angular markers
void drawMarkers(PainterInfo & pi, int x, int y) const;
/// draw two angular markers
/// add space for markers
void metricsMarkers2(Dimension & dim, int framesize = 1) const;
/// last drawn position for 'important' insets
- int xo() const;
+ int xo(BufferView const & bv) const;
/// last drawn position for 'important' insets
- int yo() const;
+ int yo(BufferView const & bv) const;
/// set x/y drawing position cache if available
virtual void setPosCache(PainterInfo const &, int, int) const {}
/// do we cover screen position x/y?
- virtual bool covers(int x, int y) const;
+ virtual bool covers(BufferView const & bv, int x, int y) const;
/// get the screen positions of the cursor (see note in cursor.C)
- virtual void cursorPos(CursorSlice const & sl, bool boundary,
- int & x, int & y) const;
+ virtual void cursorPos(BufferView const & bv,
+ CursorSlice const & sl, bool boundary, int & x, int & y) const;
/// is this an inset that can be moved into?
virtual bool isActive() const { return nargs() > 0; }
/// number of columns in gridlike structures
virtual size_t ncols() const { return 0; }
/// is called when the cursor leaves this inset
- virtual void notifyCursorLeaves(LCursor &) {}
+ // returns true if cursor is now invalid.
+ virtual bool notifyCursorLeaves(LCursor &) { return false; }
+ /// is called when the mouse enter or leave this inset
+ /// return true if this inset needs repaint
+ virtual bool setMouseHover(bool) { return false; }
/// request "external features"
virtual void validate(LaTeXFeatures &) const {}
/// Appends \c list with all labels found within this inset.
virtual void getLabelList(Buffer const &,
- std::vector<std::string> & /* list */) const {}
+ std::vector<docstring> & /* list */) const {}
/// describe content if cursor inside
- virtual void infoize(std::ostream &) const {}
+ virtual void infoize(odocstream &) const {}
/// describe content if cursor behind
- virtual void infoize2(std::ostream &) const {}
+ virtual void infoize2(odocstream &) const {}
- /// plain ascii output
- virtual int plaintext(Buffer const &, std::ostream & os,
- OutputParams const &) const;
- /// linuxdoc output
- virtual int linuxdoc(Buffer const &, std::ostream & os,
+ /// plain text output in ucs4 encoding
+ virtual int plaintext(Buffer const &, odocstream &,
OutputParams const &) const;
/// docbook output
- virtual int docbook(Buffer const &, std::ostream & os,
+ virtual int docbook(Buffer const &, odocstream & os,
OutputParams const &) const;
-
- ///
+ /// the string that is passed to the TOC
+ virtual void textString(Buffer const &, odocstream &) const {}
+
+ /** This enum indicates by which means the inset can be modified:
+ - NOT_EDITABLE: the inset's content cannot be modified at all
+ (e.g. printindex, insetspecialchar)
+ - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, url)
+ - HIGHLY_EDITABLE: content can be edited on screen (normally means that
+ insettext is contained, e.g. collapsables, tabular) */
+ // FIXME: This has not yet been fully implemented to math insets
enum EDITABLE {
///
NOT_EDITABLE = 0,
HIGHLY_EDITABLE
};
/// what appears in the minibuffer when opening
- virtual std::string const editMessage() const;
+ virtual docstring const editMessage() const;
///
virtual EDITABLE editable() const;
/// can we go further down on mouse click?
virtual bool descendable() const { return false; }
- ///
- virtual bool isTextInset() const { return false; }
+ /// does this contain text that can be change track marked in DVI?
+ virtual bool canTrackChanges() const { return false; }
+ /// is this inset based on the TextInset class?
+ virtual InsetText const * asTextInset() const { return 0; }
/// return true if the inset should be removed automatically
virtual bool autoDelete() const;
///
MATHMACRO_CODE, // 30
///
- ERROR_CODE,
- ///
CITE_CODE,
///
FLOAT_LIST_CODE,
///
VSPACE_CODE,
///
- MATHMACROARG_CODE
+ MATHMACROARG_CODE,
+ ///
+ NOMENCL_CODE, // 45
+ ///
+ NOMENCL_PRINT_CODE
};
/** returns the Code corresponding to the \c name.
/// returns true if the inset can hold an inset of given type
virtual bool insetAllowed(Code) const { return false; }
/// if this inset has paragraphs should they be output all as default
- /// paragraphs with "Standard" layout?
- virtual bool forceDefaultParagraphs(InsetBase const *) const { return false; }
+ /// paragraphs with the default layout of the text class?
+ virtual bool forceDefaultParagraphs(idx_type) const { return false; }
///
- virtual std::string const & getInsetName() const;
+ virtual docstring const & getInsetName() const;
/// used to toggle insets
/// is the inset open?
/// should this inset be handled like a normal charater
/// should we break lines after this inset?
virtual bool isLineSeparator() const { return false; }
/// should paragraph indendation be ommitted in any case?
- virtual bool neverIndent() const { return false; }
+ virtual bool neverIndent(Buffer const &) const { return false; }
/// dumps content to lyxerr
virtual void dump() const;
/// write inset in .lyx format
virtual void write(Buffer const &, std::ostream &) const {}
/// read inset in .lyx format
virtual void read(Buffer const &, LyXLex &) {}
- /// returns the number of rows (\n's) of generated tex code.
- virtual int latex(Buffer const &, std::ostream &,
+ /** Export the inset to LaTeX.
+ * Don't use a temporary stringstream if the final output is
+ * supposed to go to a file.
+ * \sa Buffer::writeLaTeXSource for the reason.
+ * \return the number of rows (\n's) of generated LaTeX code.
+ */
+ virtual int latex(Buffer const &, odocstream &,
OutputParams const &) const { return 0; }
/// returns true to override begin and end inset in file
virtual bool directWrite() const;
* Most insets have no interest in this capability, so the method
* defaults to empty.
*/
- virtual void addPreview(lyx::graphics::PreviewLoader &) const {}
+ virtual void addPreview(graphics::PreviewLoader &) const {}
+ /// Add an entry to the TocList
+ virtual void addToToc(TocList &, Buffer const &) const {}
+
public:
/// returns LyX code associated with the inset. Used for TOC, ...)
virtual Code lyxCode() const { return NO_CODE; }
virtual mode_type currentMode() const { return UNDECIDED_MODE; }
/// returns whether this inset is allowed in other insets of given mode
virtual bool allowedIn(mode_type) const { return true; }
- /// is this inset allowed within a font change?
+ /**
+ * Is this inset allowed within a font change?
+ *
+ * FIXME: noFontChange means currently that the font change is closed
+ * in LaTeX before the inset, and that the contents of the inset
+ * will be in default font. This should be changed so that the inset
+ * changes the font again.
+ */
virtual bool noFontChange() const { return false; }
- /// mark the inset as erased or not
- virtual void markErased(bool erased);
-
+ /// set the change for the entire inset
+ virtual void setChange(Change const &) {}
+ /// accept the changes within the inset
+ virtual void acceptChanges() {};
+ /// reject the changes within the inset
+ virtual void rejectChanges() {};
+
/// pretty arbitrary
virtual int width() const { return 10; }
/// pretty arbitrary
///
virtual void setStatus(LCursor &, CollapseStatus) {}
protected:
- InsetBase();
- InsetBase(InsetBase const &);
+ InsetBase() {}
+ InsetBase(InsetBase const &) {}
/** The real dispatcher.
* Gets normally called from LCursor::dispatch(). LCursor::dispatch()
* assumes the common case of 'LFUN handled, need update'.
* \sa getStatus
*/
virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+
+ /// Cached dimensions of the inset.
+ mutable Dimension dim_;
private:
virtual std::auto_ptr<InsetBase> doClone() const = 0;
};
*/
bool isHighlyEditableInset(InsetBase const * inset);
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff