* Licence details can be found in the file COPYING.
*
* \author Alejandro Aguilar Sierra
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
* \author Matthias Ettrich
*
* Full author contact details are available in file CREDITS.
#include "ColorCode.h"
#include "InsetCode.h"
+#include "Layout.h"
#include "support/strfwd.h"
+#include "support/types.h"
-#include <boost/shared_ptr.hpp>
-
-#include <vector>
namespace lyx {
class BiblioInfo;
class Buffer;
-class BufferParams;
class BufferView;
class Change;
+class CompletionList;
class Cursor;
class CursorSlice;
class Dimension;
class InsetLayout;
class InsetList;
class InsetMath;
+class InsetTabular;
class InsetText;
class LaTeXFeatures;
class Lexer;
class ParIterator;
class Text;
class TocList;
-class EmbeddedFile;
-class EmbeddedFileList;
-
namespace graphics { class PreviewLoader; }
+/** returns the InsetCode corresponding to the \c name.
+* Eg, insetCode("branch") == BRANCH_CODE
+* Implemented in 'Inset.cpp'.
+*/
+InsetCode insetCode(std::string const & name);
+/// the other way
+std::string insetName(InsetCode);
+
/// Common base class to all insets
// Do not add _any_ (non-static) data members as this would inflate
/// retrieve associated Buffer
virtual Buffer & buffer();
virtual Buffer const & buffer() const;
+ /// This checks whether the Buffer * actually points to an open
+ /// Buffer. It might not if that Buffer has been closed.
+ bool isBufferValid() const;
/// initialize view for this inset.
/**
* This is typically used after this inset is created interactively.
* Intented purpose is to sanitize internal state with regard to current
- * Buffer.
+ * Buffer. The default implementation calls updateLabels(buffer()) is
+ * the inset is labeled.
+ *
+ * \sa isLabeled()
**/
- virtual void initView() {}
+ virtual void initView();
+ /// \return true if this inset is labeled.
+ virtual bool isLabeled() const { return false; }
/// identification as math inset
virtual InsetMath * asInsetMath() { return 0; }
virtual InsetCollapsable * asInsetCollapsable() { return 0; }
/// is this inset based on the InsetCollapsable class?
virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
+ /// is this inset based on the InsetTabular class?
+ virtual InsetTabular * asInsetTabular() { return 0; }
+ /// is this inset based on the InsetTabular class?
+ virtual InsetTabular const * asInsetTabular() const { return 0; }
/// the real dispatcher
void dispatch(Cursor & cur, FuncRequest & cmd);
virtual void draw(PainterInfo & pi, int x, int y) const = 0;
/// draw inset selection if necessary
virtual void drawSelection(PainterInfo &, int, int) const {}
+ /// draw inset background if the inset has an own background and a
+ /// selection is drawn by drawSelection.
+ virtual void drawBackground(PainterInfo &, int, int) const {}
///
virtual bool editing(BufferView const * bv) const;
///
/// Force inset into LTR environment if surroundings are RTL?
virtual bool forceLTR() const { return false; }
- /// is this an inset that can be moved into?
- /// FIXME: merge with editable()
- virtual bool isActive() const { return nargs() > 0; }
/// Where should we go when we press the up or down cursor key?
virtual bool idxUpDown(Cursor & cur, bool up) const;
/// Move one cell backwards
virtual col_type col(idx_type) const { return 0; }
/// to which row belongs a cell with a given index?
virtual row_type row(idx_type) const { return 0; }
- /// cell idex corresponding to row and column;
+ /// cell index corresponding to row and column;
virtual idx_type index(row_type row, col_type col) const;
/// any additional x-offset when drawing a cell?
virtual int cellXOffset(idx_type) const { return 0; }
/// Returns true if cursor is now invalid, e.g. if former
/// insets in higher cursor slices of \c old do not exist
/// anymore.
- /// \c old is the old cursor, i.e. there is a slice pointing to this.
+ /// \c old is the old cursor, the last slice points to this.
/// \c cur is the new cursor. Use the update flags to cause a redraw.
virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
{ return false; }
+ /// Is called when the cursor enters this inset.
+ /// Returns true if cursor is now invalid, e.g. if former
+ /// insets in higher cursor slices of \c old do not exist
+ /// anymore.
+ /// \c cur is the new cursor, some slice points to this. Use the update flags to cause a redraw.
+ virtual bool notifyCursorEnters(Cursor & /*cur*/)
+ { 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; }
virtual int plaintext(odocstream &, OutputParams const &) const = 0;
/// docbook output
virtual int docbook(odocstream & os, OutputParams const &) const;
+ /// LyX HTML output
+ virtual docstring xhtml(odocstream & os, OutputParams const &) const;
/// the string that is passed to the TOC
- virtual void textString(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, href)
- - 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,
- ///
- IS_EDITABLE,
- ///
- HIGHLY_EDITABLE
- };
+ virtual void tocString(odocstream &) const {}
+
/// what appears in the minibuffer when opening
virtual docstring editMessage() const;
- ///
- virtual EDITABLE editable() const;
+ /// can the contents of the inset be edited on screen ?
+ // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
+ virtual bool editable() const;
+ /// has the Inset settings that can be modified in a dialog ?
+ virtual bool hasSettings() const;
/// can we go further down on mouse click?
+ // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
virtual bool descendable() const { return false; }
+ /// is this an inset that can be moved into?
+ /// FIXME: merge with editable()
+ // true for InsetTabular & InsetText
+ virtual bool isActive() const { return nargs() > 0; }
+
/// does this contain text that can be change track marked in DVI?
virtual bool canTrackChanges() const { return false; }
/// return true if the inset should be removed automatically
virtual bool autoDelete() const;
- class CompletionList {
- public:
- ///
- virtual ~CompletionList() {}
- ///
- virtual bool sorted() const =0;
- ///
- virtual size_t size() const =0;
- /// returns the string shown in the gui.
- virtual docstring const & data(size_t idx) const = 0;
- /// returns the resource string used to load an icon.
- virtual std::string icon(size_t /*idx*/) const { return std::string(); }
- };
-
/// Returns true if the inset supports completions.
virtual bool completionSupported(Cursor const &) const { return false; }
/// Returns true if the inset supports inline completions at the
virtual bool automaticInlineCompletion() const { return true; }
/// Return true if the popup completion should be automatic.
virtual bool automaticPopupCompletion() const { return true; }
+ /// Return true if the cursor should indicate a completion.
+ virtual bool showCompletionCursor() const { return true; }
/// Returns completion suggestions at cursor position. Return an
/// null pointer if no completion is a available or possible.
/// The caller is responsible to free the returned object!
{ return 0; }
/// Returns the completion prefix to filter the suggestions for completion.
/// This is only called if completionList returned a non-null list.
- virtual docstring completionPrefix(Cursor const &) const
- { return docstring(); }
+ virtual docstring completionPrefix(Cursor const &) const;
/// Do a completion at the cursor position. Return true on success.
/// The completion does not contain the prefix. If finished is true, the
/// completion is final. If finished is false, completion might only be
virtual bool insetAllowed(InsetCode) const { return false; }
/// should this inset use the empty layout by default rather than
/// the standard layout? (default: only if that is forced.)
- virtual bool useEmptyLayout() const { return forceEmptyLayout(); }
+ virtual bool usePlainLayout() const { return forcePlainLayout(); }
/// if this inset has paragraphs should they be forced to use the
/// empty layout?
- virtual bool forceEmptyLayout() const { return false; }
+ virtual bool forcePlainLayout(idx_type = 0) const { return false; }
/// if this inset has paragraphs should the user be allowed to
/// customize alignment, etc?
- virtual bool allowParagraphCustomization(idx_type) const { return true; }
+ virtual bool allowParagraphCustomization(idx_type = 0) const { return true; }
/// Is the width forced to some value?
virtual bool hasFixedWidth() const { return false; }
+ /// Is the content of this inset part of the output document?
+ virtual bool producesOutput() const { return true; }
+
/// \return Tool tip for this inset.
/// This default implementation returns an empty string.
virtual docstring toolTip(BufferView const & bv, int x, int y) const;
///
virtual docstring name() const;
///
- virtual InsetLayout const & getLayout(BufferParams const & bp) const;
+ virtual InsetLayout const & getLayout() const;
/// used to toggle insets
/// is the inset open?
/// should this inset be handled like a normal charater
/// is this equivalent to a space (which is BTW different from
/// a line separator)?
virtual bool isSpace() const { return false; }
+ /// is this an expandible space (rubber length)?
+ virtual bool isStretchableSpace() const { return false; }
enum DisplayType {
Inline = 0,
/// should we have a non-filled line before this inset?
virtual DisplayType display() const { return Inline; }
+ ///
+ virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
/// should we break lines after this inset?
virtual bool isLineSeparator() const { return false; }
/// should paragraph indendation be ommitted in any case?
* defaults to empty.
*/
virtual void addPreview(graphics::PreviewLoader &) const {}
+
+ /** Classifies the unicode characters appearing in a math inset
+ * depending on whether they are to be translated as latex
+ * math/text commands or used as math symbols without translation.
+ *
+ * Only math insets have interest in this classification, so the
+ * method defaults to empty.
+ */
+ virtual void initUnicodeMath() const {}
+
/// Add an entry to the TocList
/// pit is the ParConstIterator of the paragraph containing the inset
- virtual void addToToc(ParConstIterator const &) const {}
- /// report files that can be embedded with the lyx file
- virtual void registerEmbeddedFiles(EmbeddedFileList &) const {}
- /// update the properties of an embedded file of an inset
- /// the name of the embedded file should not change.
- virtual void updateEmbeddedFile(EmbeddedFile const &) {}
+ virtual void addToToc(DocIterator const &) {}
/// Fill keys with BibTeX information
virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
/// Update the counters of this inset and of its contents
enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
/// return text or mathmode if that is possible to determine
virtual mode_type currentMode() const { return UNDECIDED_MODE; }
+ /// returns whether changing mode during latex export is forbidden
+ virtual bool lockedMode() const { return false; }
/// returns whether this inset is allowed in other insets of given mode
virtual bool allowedIn(mode_type) const { return true; }
/**
/// set the change for the entire inset
virtual void setChange(Change const &) {}
/// accept the changes within the inset
- virtual void acceptChanges(BufferParams const &) {};
+ virtual void acceptChanges() {};
/// reject the changes within the inset
- virtual void rejectChanges(BufferParams const &) {};
+ virtual void rejectChanges() {};
///
virtual Dimension const dimension(BufferView const &) const;
///
virtual ColorCode backgroundColor() const;
///
+ virtual ColorCode labelColor() const;
+ ///
enum CollapseStatus {
Collapsed,
Open
enum { TEXT_TO_INSET_OFFSET = 4 };
protected:
- /// Constructor
- explicit Inset() : buffer_(0) {}
+ /// Constructors
+ Inset() : buffer_(0) {}
+ Inset(Inset const &) : buffer_(0) {}
/// replicate ourselves
friend class InsetList;
projects / lyx.git / blobdiff