X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=5fcc892dba96cd2a8417f806434e4ad5f9afc708;hb=d044d6afa7192b2119784e1415e71dad644bc335;hp=4237cfd5eb8abb677f5f762650e24c78e334af29;hpb=780bce0f96d5a1cccf62358de6c1a10ccdb3c949;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 4237cfd5eb..5fcc892dba 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -5,8 +5,8 @@ * 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. @@ -17,16 +17,20 @@ #include "ColorCode.h" #include "InsetCode.h" +#include "InsetLayout.h" +#include "LayoutEnums.h" +#include "OutputEnums.h" #include "support/strfwd.h" #include "support/types.h" +#include + namespace lyx { class BiblioInfo; class Buffer; -class BufferParams; class BufferView; class Change; class CompletionList; @@ -37,6 +41,7 @@ class DocIterator; class FuncRequest; class FuncStatus; class InsetCollapsable; +class InsetCommand; class InsetIterator; class InsetLayout; class InsetList; @@ -53,19 +58,23 @@ class ParConstIterator; class ParIterator; class Text; class TocList; -class FileNameList; - +class XHTMLStream; +class otexstream; namespace graphics { class PreviewLoader; } -/** returns the InsetCode corresponding to the \c name. -* Eg, insetCode("branch") == BRANCH_CODE -* Implemented in 'Inset.cpp'. -*/ +/// returns the InsetCode corresponding to the \c name. +/// Eg, insetCode("branch") == BRANCH_CODE InsetCode insetCode(std::string const & name); -/// the other way +/// returns the Inset name corresponding to the \c InsetCode. +/// Eg, insetName(BRANCH_CODE) == "branch" std::string insetName(InsetCode); +/// returns the Inset name corresponding to the \c InsetCode. +/// Eg, insetDisplayName(BRANCH_CODE) == _("Branch") +docstring insetDisplayName(InsetCode); +/// +static int const TOC_ENTRY_LENGTH = 40; /// Common base class to all insets @@ -79,7 +88,7 @@ public: enum EntryDirection { ENTRY_DIRECTION_IGNORE, ENTRY_DIRECTION_RIGHT, - ENTRY_DIRECTION_LEFT, + ENTRY_DIRECTION_LEFT }; /// typedef ptrdiff_t difference_type; @@ -98,30 +107,32 @@ public: virtual ~Inset() {} /// change associated Buffer - /// FIXME this should go. virtual void setBuffer(Buffer & buffer); /// 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. + /// Returns true if buffer_ actually points to a Buffer that has + /// been loaded into LyX and is still open. Note that this will + /// always return false for cloned Buffers. If you want to allow + /// for the case of cloned Buffers, use isBufferValid(). + bool isBufferLoaded() const; + /// Returns true if this is a loaded buffer or a cloned buffer. 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. The default implementation calls updateLabels(buffer()) is - * the inset is labeled. - * - * \sa isLabeled() + * Buffer. **/ - 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; } + /// identification as math inset + virtual InsetMath const * asInsetMath() const { 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 InsetText class? @@ -136,6 +147,10 @@ public: virtual InsetTabular * asInsetTabular() { return 0; } /// is this inset based on the InsetTabular class? virtual InsetTabular const * asInsetTabular() const { return 0; } + /// is this inset based on the InsetCommand class? + virtual InsetCommand * asInsetCommand() { return 0; } + /// is this inset based on the InsetCommand class? + virtual InsetCommand const * asInsetCommand() const { return 0; } /// the real dispatcher void dispatch(Cursor & cur, FuncRequest & cmd); @@ -168,16 +183,18 @@ public: virtual Inset * editXY(Cursor & cur, int x, int y); /// compute the size of the object returned in dim - /// \retval true if metrics changed. 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 {} + /// 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; /// - virtual bool showInsetDialog(BufferView *) const { return false; } + virtual bool showInsetDialog(BufferView *) const; /// draw inset decoration if necessary. /// This can use \c drawMarkers() for example. @@ -204,16 +221,15 @@ public: 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; } + /// Allow multiple blanks + virtual bool isFreeSpacing() const; + /// Don't eliminate empty paragraphs + virtual bool allowEmpty() const; + /// Force inset into LTR environment if surroundings are RTL + virtual bool forceLTR() const; + /// whether to include this inset in the strings generated for the TOC + virtual bool isInToc() const; - /// 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 @@ -245,10 +261,6 @@ public: virtual row_type row(idx_type) const { return 0; } /// 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; } - /// any additional y-offset when drawing a cell? - virtual int cellYOffset(idx_type) const { return 0; } /// number of embedded cells virtual size_t nargs() const { return 0; } /// number of rows in gridlike structures @@ -259,23 +271,35 @@ public: /// 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 mouse enter or leave this inset - /// return true if this inset needs repaint - virtual bool setMouseHover(bool) { 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 enters or leaves this inset + /// return true if this inset needs a repaint + virtual bool setMouseHover(BufferView const *, bool) const + { return false; } /// return true if this inset is hovered (under mouse) /// This is by now only used by mathed to draw corners /// (Inset::drawMarkers() and Inset::drawMarkers2()). /// Other insets do not have to redefine this function to /// return the correct status of mouseHovered. - virtual bool mouseHovered() const { return false; } + virtual bool mouseHovered(BufferView const *) const { return false; } /// request "external features" virtual void validate(LaTeXFeatures &) const {} + /// Validate LFUN_INSET_MODIFY argument. + virtual bool validateModifyArgument(docstring const &) const { return true; } + /// describe content if cursor inside virtual void infoize(odocstream &) const {} /// describe content if cursor behind @@ -286,33 +310,43 @@ public: /// plain text output in ucs4 encoding /// return the number of characters; in case of multiple lines of /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line - virtual int plaintext(odocstream &, OutputParams const &) const = 0; + virtual int plaintext(odocstringstream &, OutputParams const &, + size_t max_length = INT_MAX) const = 0; /// docbook output virtual int docbook(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 - }; - /// what appears in the minibuffer when opening - virtual docstring editMessage() const; - /// - virtual EDITABLE editable() const; + /// XHTML output + /// the inset is expected to write XHTML to the XHTMLStream + /// \return any "deferred" material that should be written outside the + /// normal stream, and which will in fact be written after the current + /// paragraph closes. this is appropriate e.g. for floats. + virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const; + + /// Writes a string representation of the inset to the odocstream. + /// This one should be called when you want the whole contents of + /// the inset. + virtual void toString(odocstream &) const {} + /// Appends a potentially abbreviated version of the inset to + /// \param str. Intended for use by the TOC. + virtual void forOutliner(docstring & str, + size_t maxlen = TOC_ENTRY_LENGTH) 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? - virtual bool descendable() const { return false; } + // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular + virtual bool descendable(BufferView const &) 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; } + /// can we click at the specified position ? + virtual bool clickable(int, int) const { return false; } + /// Move one cell backwards + virtual bool allowsCaptionVariation(std::string const &) const { return false; } + /// 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 @@ -360,7 +394,8 @@ public: 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 = 0) 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; } @@ -371,30 +406,33 @@ public: /// This default implementation returns an empty string. virtual docstring toolTip(BufferView const & bv, int x, int y) const; + /// \return Context menu identifier. This function determines + /// whose Inset's menu should be shown for the given position. + virtual std::string contextMenu(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; + virtual std::string contextMenuName() 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 layoutName() const; /// - virtual docstring name() const; + virtual InsetLayout const & getLayout() const; /// - virtual InsetLayout const & getLayout(BufferParams const & bp) const; - /// used to toggle insets - /// is the inset open? - /// should this inset be handled like a normal charater + virtual bool isPassThru() const { return getLayout().isPassThru(); } + /// Is this inset's layout defined in the document's textclass? + bool undefined() const; + /// should this inset be handled like a normal character? + /// (a character can be a letter or punctuation) virtual bool isChar() const { return false; } /// is this equivalent to a letter? + /// (a letter is a character that is considered part of a word) 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; } - /// is this an expandible space (rubber length)? - virtual bool isStretchableSpace() const { return false; } + /// does this inset try to use all available space (like \\hfill does)? + virtual bool isHfill() const { return false; } enum DisplayType { Inline = 0, @@ -405,6 +443,8 @@ public: /// 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? @@ -419,9 +459,8 @@ public: * 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(odocstream &, OutputParams const &) const { return 0; } + virtual void latex(otexstream &, OutputParams const &) const {} /// returns true to override begin and end inset in file virtual bool directWrite() const; /// @@ -436,14 +475,28 @@ public: * Most insets have no interest in this capability, so the method * defaults to empty. */ - virtual void addPreview(graphics::PreviewLoader &) const {} + virtual void addPreview(DocIterator const &, + 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(DocIterator const &) {} - /// Fill keys with BibTeX information - virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {} - /// Update the counters of this inset and of its contents - virtual void updateLabels(ParIterator const &) {} + /// Pass a DocIterator that points at the paragraph containing + /// the inset + virtual void addToToc(DocIterator const & /* di */, bool /* output_active */) const {} + /// Collect BibTeX information + virtual void collectBibKeys(InsetIterator const &) const {} + /// Update the counters of this inset and of its contents. + /// The boolean indicates whether we are preparing for output, e.g., + /// of XHTML. + virtual void updateBuffer(ParIterator const &, UpdateType) {} /// Updates the inset's dialog virtual Buffer const * updateFrontend() const; @@ -456,44 +509,58 @@ public: 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 only ascii chars are allowed during latex export + virtual bool asciiOnly() const { return false; } /// 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? - * - * 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. + * The font is inherited from the parent for LaTeX export if this + * method returns true. No open font changes are closed in front of + * the inset for LaTeX export, and the font is inherited for all other + * exports as well as on screen. + * If this method returns false all open font changes are closed in + * front of the inset for LaTeX export. The default font is used + * inside the inset for all exports and on screen. + */ + virtual bool inheritFont() const { return true; } + /** + * If this method returns true all explicitly set font attributes + * are reset during editing operations. + * For copy/paste operations the language is never changed, since + * the language of a given text never changes if the text is + * formatted differently, while other font attribues like size may + * need to change if the text is copied from one environment to + * another one. + * If this method returns false no font attribute is reset. + * The default implementation returns true if the resetFont layout + * tag is set and otherwise the negation of inheritFont(), + * since inherited inset font attributes do not need to be changed, + * and non-inherited ones need to be set explicitly. */ - virtual bool noFontChange() const { return false; } + virtual bool resetFontEdit() const; /// 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; /// - int scroll() const { return 0; } - /// - virtual ColorCode backgroundColor() const; - /// - enum CollapseStatus { - Collapsed, - Open - }; + virtual ColorCode backgroundColor(PainterInfo const &) const; /// - virtual void setStatus(Cursor &, CollapseStatus) {} + virtual ColorCode labelColor() const; // enum { TEXT_TO_INSET_OFFSET = 4 }; protected: - /// Constructor - explicit Inset() : buffer_(0) {} + /// Constructors + Inset(Buffer * buf) : buffer_(buf) {} + Inset(Inset const &) : buffer_(0) {} /// replicate ourselves friend class InsetList; @@ -504,7 +571,7 @@ protected: * Gets normally called from Cursor::dispatch(). Cursor::dispatch() * assumes the common case of 'LFUN handled, need update'. * This has to be overriden by calling Cursor::undispatched() or - * Cursor::noUpdate() if appropriate. + * Cursor::noScreenUpdate() if appropriate. * If you need to call the dispatch method of some inset directly * you may have to explicitly request an update at that place. Don't * do it in doDispatch(), since that causes nested updates when