#include "support/strfwd.h"
#include "support/types.h"
+#include "support/FileNameList.h"
#include <climits>
class CursorSlice;
class Dimension;
class DocIterator;
+class Encoding;
class FuncRequest;
class FuncStatus;
class InsetArgument;
-class InsetCollapsable;
+class InsetCollapsible;
class InsetCommand;
class InsetIterator;
class InsetLayout;
/**
* This is typically used after this inset is created interactively.
* Intented purpose is to sanitize internal state with regard to current
- * Buffer.
+ * Buffer.
**/
virtual void initView() {}
/// \return true if this inset is labeled.
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; }
+ /// is this inset based on the InsetCollapsible class?
+ virtual InsetCollapsible * asInsetCollapsible() { return 0; }
+ /// is this inset based on the InsetCollapsible class?
+ virtual InsetCollapsible const * asInsetCollapsible() const { return 0; }
/// is this inset based on the InsetTabular class?
virtual InsetTabular * asInsetTabular() { return 0; }
/// is this inset based on the InsetTabular class?
FuncStatus & status) const;
/// cursor enters
- virtual void edit(Cursor & cur, bool front,
+ virtual void edit(Cursor & cur, bool front,
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
- /// cursor enters
+ /// sets cursor recursively descending into nested editable insets
+ /**
+ \return the inset pointer if x,y is covering that inset
+ \param x,y are absolute screen coordinates.
+ */
/// Note: this method must preserve the selection status. See:
/// https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg199001.html
virtual Inset * editXY(Cursor & cur, int x, int y);
virtual bool showInsetDialog(BufferView *) const;
/// draw two angular markers
- void drawMarkers(PainterInfo & pi, int x, int y) const;
- /// draw four angular markers
- void drawMarkers2(PainterInfo & pi, int x, int y) const;
+ virtual void drawMarkers(PainterInfo & pi, int x, int y) const;
/// add space for markers
void metricsMarkers(Dimension & dim, int framesize = 1) const;
/// add space for markers
/// Don't eliminate empty paragraphs
virtual bool allowEmpty() const;
/// Force inset into LTR environment if surroundings are RTL
- virtual bool forceLTR() const;
+ virtual bool forceLTR(OutputParams const &) const;
/// whether to include this inset in the strings generated for the TOC
virtual bool isInToc() const;
/// 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, e.g. if former
- /// insets in higher cursor slices of \c old do not exist
+ /// 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, 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
+ /// 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 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
+ /// 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
+ /// Other insets do not have to redefine this function to
/// return the correct status of mouseHovered.
virtual bool mouseHovered(BufferView const *) const { return false; }
size_t const maxlen = TOC_ENTRY_LENGTH,
bool const shorten = true) const;
+ /// Can a cursor be put in there ?
+ /// Forced to false for insets that have hidden contents, like
+ /// InsetMathCommand and InsetInfo.
+ virtual bool isActive() const { return nargs() > 0; }
/// can the contents of the inset be edited on screen ?
- // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
+ // equivalent to isActive except for closed InsetCollapsible
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
+ /// true for InsetCaption, InsetCollapsibles (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(BufferView const &, int, int) const { return false; }
/// Move one cell backwards
/// 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
+ virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
{ return false; }
/// Return true if the inline completion should be automatic.
virtual bool automaticInlineCompletion() 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 * createCompletionList(Cursor const &) const
+ virtual CompletionList const * createCompletionList(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.
/// 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*/)
+ 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*/,
+ 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(InsetCode) const { return false; }
- /// should this inset use the empty layout by default rather than
+ /// should this inset use the empty layout by default rather than
/// the standard layout? (default: only if that is forced.)
virtual bool usePlainLayout() const { return forcePlainLayout(); }
/// if this inset has paragraphs should they be forced to use the
/// if this inset has paragraphs should they be forced to use a
/// local font language switch?
virtual bool forceLocalFontSwitch() const { return false; }
+ /// Does the inset force a specific encoding?
+ virtual Encoding const * forcedEncoding(Encoding const *, Encoding const *) const
+ { return 0; }
+
/// Is the content of this inset part of the output document?
virtual bool producesOutput() const { return true; }
/// either plain text or Qt html, and formatToolTip will be called
/// on it before display in both cases.
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;
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?
+ /// should paragraph indendation be omitted in any case?
virtual bool neverIndent() const { return false; }
/// dumps content to lyxerr
virtual void dump() const;
UpdateType /* utype*/,
TocBackend & /* tocbackend */) const {}
/// Collect BibTeX information
- virtual void collectBibKeys(InsetIterator const &) const {}
+ virtual void collectBibKeys(InsetIterator const &, support::FileNameList &) const {}
/// Update the counters of this inset and of its contents.
/// The boolean indicates whether we are preparing for output, e.g.,
/// of XHTML.
projects / lyx.git / blobdiff