X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=c3b72f4debcade449f5b78f8f0f2f0eaf7f94b6c;hb=2c357c1d23b7b83839a9beb8225d4f1ae4f793b4;hp=850b1b1dc16d7ecfbc6c18e424a427d6e95a9881;hpb=b52c339cceb3d939a26adf106bab72c835d66a17;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 850b1b1dc1..c3b72f4deb 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -15,13 +15,13 @@ #ifndef INSETBASE_H #define INSETBASE_H -//#include "BiblioInfo.h" -#include "Changes.h" -#include "Dimension.h" +#include "ColorCode.h" +#include "InsetCode.h" -#include "support/docstream.h" +#include "support/strfwd.h" + +#include -#include #include namespace lyx { @@ -30,25 +30,30 @@ class BiblioInfo; class Buffer; class BufferParams; class BufferView; -class ParIterator; -class ParConstIterator; +class Change; +class Cursor; class CursorSlice; -class InsetIterator; +class Dimension; class FuncRequest; class FuncStatus; +class InsetCollapsable; +class InsetIterator; class InsetLayout; +class InsetList; class InsetMath; class InsetText; class LaTeXFeatures; -class Color_color; -class Cursor; class Lexer; -class Text; +class MathAtom; class MetricsInfo; -class Dimension; -class PainterInfo; class OutputParams; +class PainterInfo; +class ParConstIterator; +class ParIterator; +class Text; class TocList; +class EmbeddedFile; +class EmbeddedFileList; namespace graphics { class PreviewLoader; } @@ -62,6 +67,12 @@ namespace graphics { class PreviewLoader; } class Inset { public: + /// + enum EntryDirection { + ENTRY_DIRECTION_IGNORE, + ENTRY_DIRECTION_RIGHT, + ENTRY_DIRECTION_LEFT, + }; /// typedef ptrdiff_t difference_type; /// short of anything else reasonable @@ -77,18 +88,20 @@ public: /// virtual base class destructor virtual ~Inset() {} - /// replicate ourselves - std::auto_ptr clone() const; /// identification as math inset virtual InsetMath * asInsetMath() { return 0; } /// true for 'math' math inset, but not for e.g. mbox virtual bool inMathed() const { return false; } - /// is this inset based on the TextInset class? - virtual InsetText * asTextInset() { return 0; } - /// is this inset based on the TextInset class? - virtual InsetText const * asTextInset() const { return 0; } - + /// is this inset based on the InsetText class? + virtual InsetText * asInsetText() { return 0; } + /// is this inset based on the InsetText class? + virtual InsetText const * asInsetText() const { return 0; } + /// is this inset based on the InsetCollapsable class? + virtual InsetCollapsable * asInsetCollapsable() { return 0; } + /// is this inset based on the InsetCollapsable class? + virtual InsetCollapsable const * asInsetCollapsable() const { return 0; } + /// the real dispatcher void dispatch(Cursor & cur, FuncRequest & cmd); /** @@ -114,19 +127,20 @@ public: FuncStatus & status) const; /// cursor enters - virtual void edit(Cursor & cur, bool left); + virtual void edit(Cursor & cur, bool front, + EntryDirection entry_from = ENTRY_DIRECTION_IGNORE); /// cursor enters virtual Inset * editXY(Cursor & cur, int x, int y); /// compute the size of the object returned in dim /// \retval true if metrics changed. - virtual bool metrics(MetricsInfo & mi, Dimension & dim) const = 0; + virtual void 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 void drawSelection(PainterInfo &, int, int) const {} /// - virtual bool editing(BufferView * bv) const; + virtual bool editing(BufferView const * bv) const; /// virtual bool showInsetDialog(BufferView *) const { return false; } @@ -147,30 +161,39 @@ public: int yo(BufferView const & bv) const; /// set x/y drawing position cache if available virtual void setPosCache(PainterInfo const &, int, int) const; + /// + void setDimCache(MetricsInfo const &, Dimension const &) const; /// do we cover screen position x/y? virtual bool covers(BufferView const & bv, int x, int y) const; /// get the screen positions of the cursor (see note in Cursor.cpp) virtual void cursorPos(BufferView const & bv, CursorSlice const & sl, bool boundary, int & x, int & y) const; + /// + virtual bool isFreeSpacing() const { return false; } + /// + virtual bool allowEmpty() const { return false; } + /// 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 to the left - virtual bool idxLeft(Cursor &) const { return false; } - /// Move one cell to the right - virtual bool idxRight(Cursor &) const { return false; } + /// Move one cell backwards + virtual bool idxBackward(Cursor &) const { return false; } + /// Move one cell forward + virtual bool idxForward(Cursor &) const { return false; } - /// Move one physical cell up + /// Move to the next cell virtual bool idxNext(Cursor &) const { return false; } - /// Move one physical cell down + /// Move to the previous cell virtual bool idxPrev(Cursor &) const { return false; } - /// Target pos when we enter the inset from the left by pressing "Right" + /// Target pos when we enter the inset while moving forward virtual bool idxFirst(Cursor &) const { return false; } - /// Target pos when we enter the inset from the right by pressing "Left" + /// Target pos when we enter the inset while moving backwards virtual bool idxLast(Cursor &) const { return false; } /// Delete a cell and move cursor @@ -198,7 +221,8 @@ public: /// number of columns in gridlike structures virtual size_t ncols() const { return 0; } /// is called when the cursor leaves this inset - // returns true if cursor is now invalid. + /// returns true if cursor is now invalid. The cursor parameter + /// is _not_ necessarily pointing to the inset. virtual bool notifyCursorLeaves(Cursor &) { return false; } /// is called when the mouse enter or leave this inset /// return true if this inset needs repaint @@ -239,7 +263,7 @@ public: /** 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) + - 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 @@ -262,127 +286,78 @@ public: /// return true if the inset should be removed automatically virtual bool autoDelete() const; - /** This is not quite the correct place for this enum. I think - the correct would be to let each subclass of Inset declare - its own enum code. Actually the notion of an Inset::Code - should be avoided, but I am not sure how this could be done - in a cleaner way. */ - enum Code { - /// - NO_CODE, // 0 - /// - TOC_CODE, // do these insets really need a code? (ale) - /// - QUOTE_CODE, - /// - MARK_CODE, - /// - REF_CODE, - /// - URL_CODE, // 5 - /// - HTMLURL_CODE, - /// - SEPARATOR_CODE, - /// - ENDING_CODE, - /// - LABEL_CODE, - /// - NOTE_CODE, // 10 - /// - ACCENT_CODE, - /// - MATH_CODE, - /// - INDEX_CODE, - /// - INCLUDE_CODE, - /// - GRAPHICS_CODE, // 15 - /// - BIBITEM_CODE, - /// - BIBTEX_CODE, - /// - TEXT_CODE, - /// - ERT_CODE, - /// - FOOT_CODE, // 20 - /// - MARGIN_CODE, + class CompletionList { + public: /// - FLOAT_CODE, + virtual ~CompletionList() {} /// - WRAP_CODE, - /// - SPACE_CODE, // 25 - /// - SPECIALCHAR_CODE, - /// - TABULAR_CODE, - /// - EXTERNAL_CODE, -#if 0 - /// - THEOREM_CODE, -#endif - /// - CAPTION_CODE, - /// - MATHMACRO_CODE, // 30 - /// - CITE_CODE, - /// - FLOAT_LIST_CODE, - /// - INDEX_PRINT_CODE, - /// - OPTARG_CODE, // 35 - /// - ENVIRONMENT_CODE, - /// - HFILL_CODE, - /// - NEWLINE_CODE, - /// - LINE_CODE, - /// - BRANCH_CODE, // 40 - /// - BOX_CODE, - /// - CHARSTYLE_CODE, - /// - VSPACE_CODE, - /// - MATHMACROARG_CODE, - /// - NOMENCL_CODE, // 45 - /// - NOMENCL_PRINT_CODE, - /// - PAGEBREAK_CODE, - /// - LISTINGS_CODE + virtual size_t size() const =0; + /// returns the string shown in the gui. + virtual docstring 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 the Code corresponding to the \c name. - * Eg, translate("branch") == BRANCH_CODE - */ - static Code translate(std::string const & name); + /// 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 + /// cursor position. In this case the completion might be stored + /// in the BufferView's inlineCompletion property. + virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const + { return false; } + /// Return true if the inline completion should be automatic. + virtual bool automaticInlineCompletion() const { return true; } + /// Return true if the popup completion should be automatic. + virtual bool automaticPopupCompletion() 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! + virtual CompletionList const * completionList(Cursor const &) const + { 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(); } + /// 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 + /// a partial completion. + virtual bool insertCompletion(Cursor & /*cur*/, + docstring const & /*completion*/, bool /*finished*/) + { return false; } + /// Get the completion inset position and size + virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/, + Dimension & /*dim*/) const {} /// 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 the default layout of the text class? - virtual bool forceDefaultParagraphs(idx_type) const { return false; } + 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(); } + /// if this inset has paragraphs should they be forced to use the + /// empty layout? + virtual bool forceEmptyLayout() 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; } /// Is the width forced to some value? virtual bool hasFixedWidth() const { return false; } + /// \return Tool tip for this inset. + /// This default implementation returns an empty string. + virtual docstring toolTip(BufferView const & bv, int x, int y) const; + + /// \return Context menu identifier for this inset. + /// This default implementation returns an empty string. + virtual docstring contextMenu(BufferView const & bv, int x, int y) const; + + // FIXME This should really disappear in favor of + // docstring name() const { return from_ascii(insetName(lyxCode()))); } + // There's no reason to be using different names in different places. + // But to do this we would need to change the file format, since the names + // used there don't correspond to what is used here. /// - virtual docstring name() const { return from_ascii("unknown"); } + virtual docstring name() const; /// virtual InsetLayout const & getLayout(BufferParams const & bp) const; /// used to toggle insets @@ -439,17 +414,23 @@ public: virtual void addPreview(graphics::PreviewLoader &) const {} /// Add an entry to the TocList /// pit is the ParConstIterator of the paragraph containing the inset - virtual void addToToc(TocList &, Buffer const &, ParConstIterator const &) const {} + virtual void addToToc(Buffer const &, ParConstIterator const &) const {} + /// report files that can be embedded with the lyx file + virtual void registerEmbeddedFiles(Buffer const &, EmbeddedFileList &) const {} + /// use embedded or external file after the embedding status of a file is changed + virtual void updateEmbeddedFile(Buffer const &, EmbeddedFile const &) {} /// Fill keys with BibTeX information virtual void fillWithBibKeys(Buffer const &, - BiblioInfo &, InsetIterator const &) const { return; } + BiblioInfo &, InsetIterator const &) const {} /// Update the counters of this inset and of its contents virtual void updateLabels(Buffer const &, ParIterator const &) {} + /// Updates the inset's dialog + virtual Buffer const * updateFrontend() const; public: /// returns LyX code associated with the inset. Used for TOC, ...) - virtual Code lyxCode() const { return NO_CODE; } + virtual InsetCode lyxCode() const { return NO_CODE; } /// -1: text mode, 1: math mode, 0 undecided enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE}; @@ -474,18 +455,12 @@ public: /// reject the changes within the inset virtual void rejectChanges(BufferParams const &) {}; - /// FIXME: move dim_ out of Inset! - Dimension const & dimension() { return dim_; } - /// inset width. - int width() const { return dim_.wid; } - /// inset ascent. - int ascent() const { return dim_.asc; } - /// inset descent. - int descent() const { return dim_.des; } + /// + virtual Dimension const dimension(BufferView const &) const; /// int scroll() const { return 0; } /// - virtual Color_color backgroundColor() const; + virtual ColorCode backgroundColor() const; /// enum CollapseStatus { Collapsed, @@ -497,7 +472,12 @@ public: enum { TEXT_TO_INSET_OFFSET = 4 }; protected: - Inset(); + Inset() {} + + /// replicate ourselves + friend class InsetList; + friend class MathAtom; + virtual Inset * clone() const = 0; /** The real dispatcher. * Gets normally called from Cursor::dispatch(). Cursor::dispatch() @@ -511,40 +491,8 @@ protected: * \sa getStatus */ virtual void doDispatch(Cursor & cur, FuncRequest & cmd); - - /// Cached dimensions of the inset. - mutable Dimension dim_; -private: - virtual std::auto_ptr doClone() const = 0; -}; - - -/** - * returns true if pointer argument is valid - * and points to an editable inset - */ -bool isEditableInset(Inset const * inset); - - -/** - * returns true if pointer argument is valid - * and points to a highly editable inset - */ -bool isHighlyEditableInset(Inset const * inset); - -/** \c Inset_code is a wrapper for Inset::Code. - * It can be forward-declared and passed as a function argument without - * having to expose Inset.h. - */ -class Inset_code { - Inset::Code val_; -public: - Inset_code(Inset::Code val) : val_(val) {} - operator Inset::Code() const { return val_; } }; - - } // namespace lyx #endif