src/insets/InsetText.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetText.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETTEXT_H
  13 #define INSETTEXT_H
  14
  15 #include "Inset.h"
  16
  17 #include "ColorCode.h"
  18 #include "Text.h"
  19
  20 #include "insets/InsetLayout.h"
  21
  22 namespace lyx {
  23
  24 class CompletionList;
  25 class CursorSlice;
  26 class Dimension;
  27 class ParagraphList;
  28 class InsetCaption;
  29 class InsetTabular;
  30
  31 /**
  32  A text inset is like a TeX box to write full text
  33  (including styles and other insets) in a given space.
  34  */
  35 class InsetText : public Inset {
  36 public:
  37         enum UsePlain {
  38                 DefaultLayout,
  39                 PlainLayout
  40         };
  41         /// \param buffer
  42         /// \param useplain whether to use the plain layout
  43         /// This is needed because we cannot call the virtual function
  44         /// usePlainLayout() from within the constructor.
  45         explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout);
  46         ///
  47         InsetText(InsetText const &);
  48         ///
  49         void setBuffer(Buffer &);
  50
  51         ///
  52         Dimension const dimension(BufferView const &) const;
  53
  54         /// empty inset to empty par
  55         void clear();
  56         ///
  57         void read(Lexer & lex);
  58         ///
  59         void write(std::ostream & os) const;
  60         ///
  61         void metrics(MetricsInfo & mi, Dimension & dim) const;
  62         ///
  63         void draw(PainterInfo & pi, int x, int y) const;
  64         ///
  65         bool editable() const { return true; }
  66         ///
  67         bool canTrackChanges() const { return true; }
  68         ///
  69         InsetText * asInsetText() { return this; }
  70         ///
  71         InsetText const * asInsetText() const { return this; }
  72         ///
  73         Text & text() { return text_; }
  74         Text const & text() const { return text_; }
  75         ///
  76         void latex(otexstream &, OutputParams const &) const;
  77         ///
  78         int plaintext(odocstream &, OutputParams const &) const;
  79         ///
  80         int docbook(odocstream &, OutputParams const &) const;
  81         ///
  82         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  83         ///
  84         enum XHTMLOptions {
  85                 JustText = 0,
  86                 WriteOuterTag = 1,
  87                 WriteLabel = 2,
  88                 WriteInnerTag = 4,
  89                 WriteEverything = 7
  90         };
  91         ///
  92         docstring insetAsXHTML(XHTMLStream &, OutputParams const &,
  93                                XHTMLOptions) const;
  94         ///
  95         void validate(LaTeXFeatures & features) const;
  96
  97         /// return the argument(s) only
  98         void getArgs(otexstream & os, OutputParams const &, bool const post = false) const;
  99
 100         /// return x,y of given position relative to the inset's baseline
 101         void cursorPos(BufferView const & bv, CursorSlice const & sl,
 102                 bool boundary, int & x, int & y) const;
 103         ///
 104         InsetCode lyxCode() const { return TEXT_CODE; }
 105         ///
 106         void setText(docstring const &, Font const &, bool trackChanges);
 107         ///
 108         void setAutoBreakRows(bool);
 109         ///
 110         bool getAutoBreakRows() const { return text_.autoBreakRows_; }
 111         ///
 112         void setDrawFrame(bool);
 113         ///
 114         ColorCode frameColor() const;
 115         ///
 116         void setFrameColor(ColorCode);
 117         ///
 118         Text * getText(int i) const {
 119                 return (i == 0) ? const_cast<Text*>(&text_) : 0;
 120         }
 121         ///
 122         virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 123
 124         ///
 125         void fixParagraphsFont();
 126
 127         /// set the change for the entire inset
 128         void setChange(Change const & change);
 129         /// accept the changes within the inset
 130         void acceptChanges();
 131         /// reject the changes within the inset
 132         void rejectChanges();
 133
 134         /// append text onto the existing text
 135         void appendParagraphs(ParagraphList &);
 136
 137         ///
 138         void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
 139
 140         ///
 141         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 142         ///
 143         Inset * editXY(Cursor & cur, int x, int y);
 144
 145         /// number of cells in this inset
 146         size_t nargs() const { return 1; }
 147         ///
 148         ParagraphList & paragraphs();
 149         ///
 150         ParagraphList const & paragraphs() const;
 151         ///
 152         bool insetAllowed(InsetCode) const;
 153         ///
 154         bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); }
 155         ///
 156         virtual bool isMacroScope() const { return false; }
 157         ///
 158         virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
 159         ///
 160         /// should paragraphs be forced to use the empty layout?
 161         virtual bool forcePlainLayout(idx_type = 0) const
 162                 { return getLayout().forcePlainLayout(); }
 163         /// should the user be allowed to customize alignment, etc.?
 164         virtual bool allowParagraphCustomization(idx_type = 0) const
 165                 { return getLayout().allowParagraphCustomization(); }
 166
 167         /// Update the counters of this inset and of its contents
 168         virtual void updateBuffer(ParIterator const &, UpdateType);
 169         ///
 170         void setMacrocontextPositionRecursive(DocIterator const & pos);
 171         ///
 172         void toString(odocstream &) const;
 173         ///
 174         void forToc(docstring &, size_t) const;
 175         ///
 176         void addToToc(DocIterator const &) const;
 177         ///
 178         Inset * clone() const { return new InsetText(*this); }
 179         ///
 180         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 181
 182         ///
 183         bool completionSupported(Cursor const &) const;
 184         ///
 185         bool inlineCompletionSupported(Cursor const & cur) const;
 186         ///
 187         bool automaticInlineCompletion() const;
 188         ///
 189         bool automaticPopupCompletion() const;
 190         ///
 191         bool showCompletionCursor() const;
 192         ///
 193         CompletionList const * createCompletionList(Cursor const & cur) const;
 194         ///
 195         docstring completionPrefix(Cursor const & cur) const;
 196         ///
 197         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
 198         ///
 199         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
 200         /// returns the text to be used as tooltip
 201         /// \param prefix: a string that will preced the tooltip,
 202         /// e.g., "Index: ".
 203         /// \param numlines: the number of lines in the tooltip
 204         /// \param len: length of those lines
 205         docstring toolTipText(docstring prefix = empty_docstring(),
 206                         size_t numlines = 5, size_t len = 80) const;
 207
 208         ///
 209         std::string contextMenu(BufferView const &, int, int) const;
 210         ///
 211         std::string contextMenuName() const;
 212         ///
 213         void doDispatch(Cursor & cur, FuncRequest & cmd);
 214 protected:
 215         ///
 216         InsetCaption const * getCaptionInset() const;
 217         ///
 218         docstring getCaptionText(OutputParams const &) const;
 219         ///
 220         docstring getCaptionHTML(OutputParams const &) const;
 221 private:
 222         ///
 223         bool drawFrame_;
 224         ///
 225         ColorCode frame_color_;
 226         ///
 227         mutable pit_type old_pit;
 228         ///
 229         mutable Text text_;
 230 };
 231
 232
 233 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);
 234
 235 } // namespace lyx
 236
 237 #endif