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 namespace lyx {
  21
  22 class Buffer;
  23 class BufferParams;
  24 class BufferView;
  25 class CompletionList;
  26 class CursorSlice;
  27 class Dimension;
  28 class ParagraphList;
  29 class InsetCaption;
  30 class InsetTabular;
  31
  32 /**
  33  A text inset is like a TeX box to write full text
  34  (including styles and other insets) in a given space.
  35  */
  36 class InsetText : public Inset {
  37 public:
  38         enum UsePlain {
  39                 DefaultLayout,
  40                 PlainLayout
  41         };
  42         /// \param buffer
  43         /// \param useplain whether to use the plain layout
  44         /// This is needed because we cannot call the virtual function
  45         /// usePlainLayout() from within the constructor.
  46         explicit InsetText(Buffer const & buffer, UsePlain type = DefaultLayout);
  47         ///
  48         InsetText(InsetText const &);
  49         ///
  50         void setBuffer(Buffer &);
  51
  52         ///
  53         Dimension const dimension(BufferView const &) const;
  54
  55         /// empty inset to empty par
  56         void clear();
  57         ///
  58         void read(Lexer & lex);
  59         ///
  60         void write(std::ostream & os) const;
  61         ///
  62         void metrics(MetricsInfo & mi, Dimension & dim) const;
  63         ///
  64         void draw(PainterInfo & pi, int x, int y) const;
  65         ///
  66         docstring editMessage() const;
  67         ///
  68         bool editable() const { return true; }
  69         ///
  70         bool canTrackChanges() const { return true; }
  71         ///
  72         InsetText * asInsetText() { return this; }
  73         ///
  74         InsetText const * asInsetText() const { return this; }
  75         ///
  76         Text & text() { return text_; }
  77         Text const & text() const { return text_; }
  78         ///
  79         int latex(odocstream &, OutputParams const &) const;
  80         ///
  81         int plaintext(odocstream &, OutputParams const &) const;
  82         ///
  83         int docbook(odocstream &, OutputParams const &) const;
  84         ///
  85         docstring xhtml(odocstream &, OutputParams const &) const;
  86         ///
  87         void validate(LaTeXFeatures & features) const;
  88
  89         /// return x,y of given position relative to the inset's baseline
  90         void cursorPos(BufferView const & bv, CursorSlice const & sl,
  91                 bool boundary, int & x, int & y) const;
  92         ///
  93         InsetCode lyxCode() const { return TEXT_CODE; }
  94         ///
  95         void setText(docstring const &, Font const &, bool trackChanges);
  96         ///
  97         void setAutoBreakRows(bool);
  98         ///
  99         bool getAutoBreakRows() const { return text_.autoBreakRows_; }
 100         ///
 101         void setDrawFrame(bool);
 102         ///
 103         ColorCode frameColor() const;
 104         ///
 105         void setFrameColor(ColorCode);
 106         ///
 107         bool showInsetDialog(BufferView *) const;
 108         ///
 109         Text * getText(int i) const {
 110                 return (i == 0) ? const_cast<Text*>(&text_) : 0;
 111         }
 112         ///
 113         virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 114
 115         /// set the change for the entire inset
 116         void setChange(Change const & change);
 117         /// accept the changes within the inset
 118         void acceptChanges(BufferParams const & bparams);
 119         /// reject the changes within the inset
 120         void rejectChanges(BufferParams const & bparams);
 121
 122         /// append text onto the existing text
 123         void appendParagraphs(ParagraphList &);
 124
 125         ///
 126         void addPreview(graphics::PreviewLoader &) const;
 127
 128         ///
 129         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 130         ///
 131         Inset * editXY(Cursor & cur, int x, int y);
 132
 133         /// number of cells in this inset
 134         size_t nargs() const { return 1; }
 135         ///
 136         ParagraphList & paragraphs();
 137         ///
 138         ParagraphList const & paragraphs() const;
 139         ///
 140         bool insetAllowed(InsetCode) const { return true; }
 141         ///
 142         bool allowSpellCheck() const { return true; }
 143         ///
 144         virtual bool isMacroScope() const { return false; }
 145         ///
 146         virtual bool allowMultiPar() const { return true; }
 147
 148         /// Update the counters of this inset and of its contents
 149         virtual void updateLabels(ParIterator const &);
 150         ///
 151         void addToToc(DocIterator const &);
 152         ///
 153         Inset * clone() const { return new InsetText(*this); }
 154         ///
 155         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 156
 157         ///
 158         bool completionSupported(Cursor const &) const;
 159         ///
 160         bool inlineCompletionSupported(Cursor const & cur) const;
 161         ///
 162         bool automaticInlineCompletion() const;
 163         ///
 164         bool automaticPopupCompletion() const;
 165         ///
 166         bool showCompletionCursor() const;
 167         ///
 168         CompletionList const * createCompletionList(Cursor const & cur) const;
 169         ///
 170         docstring completionPrefix(Cursor const & cur) const;
 171         ///
 172         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
 173         ///
 174         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
 175
 176         ///
 177         virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
 178         ///
 179         void doDispatch(Cursor & cur, FuncRequest & cmd);
 180 protected:
 181         ///
 182         InsetCaption const * getCaptionInset() const;
 183         ///
 184         docstring getCaptionText(OutputParams const &) const;
 185         ///
 186         docstring getCaptionHTML(OutputParams const &) const;
 187 private:
 188         ///
 189         void initParagraphs(UsePlain type);
 190         ///
 191         void setParagraphOwner();
 192         ///
 193         bool drawFrame_;
 194         ///
 195         ColorCode frame_color_;
 196         ///
 197         mutable pit_type old_pit;
 198         ///
 199         mutable Text text_;
 200 };
 201
 202 } // namespace lyx
 203
 204 #endif