mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-24 13:48:59 +00:00
d764a97cf4
Add a comment to strfwd.h. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@36355 a592a061-630c-0410-9148-cb99ea01b6c8
226 lines
5.7 KiB
C++
226 lines
5.7 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetText.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Jürgen Vigna
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSETTEXT_H
|
|
#define INSETTEXT_H
|
|
|
|
#include "Inset.h"
|
|
|
|
#include "ColorCode.h"
|
|
#include "Text.h"
|
|
|
|
#include "insets/InsetLayout.h"
|
|
|
|
namespace lyx {
|
|
|
|
class CompletionList;
|
|
class CursorSlice;
|
|
class Dimension;
|
|
class ParagraphList;
|
|
class InsetCaption;
|
|
class InsetTabular;
|
|
|
|
/**
|
|
A text inset is like a TeX box to write full text
|
|
(including styles and other insets) in a given space.
|
|
*/
|
|
class InsetText : public Inset {
|
|
public:
|
|
enum UsePlain {
|
|
DefaultLayout,
|
|
PlainLayout
|
|
};
|
|
/// \param buffer
|
|
/// \param useplain whether to use the plain layout
|
|
/// This is needed because we cannot call the virtual function
|
|
/// usePlainLayout() from within the constructor.
|
|
explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout);
|
|
///
|
|
InsetText(InsetText const &);
|
|
///
|
|
void setBuffer(Buffer &);
|
|
|
|
///
|
|
Dimension const dimension(BufferView const &) const;
|
|
|
|
/// empty inset to empty par
|
|
void clear();
|
|
///
|
|
void read(Lexer & lex);
|
|
///
|
|
void write(std::ostream & os) const;
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const;
|
|
///
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
|
///
|
|
bool editable() const { return true; }
|
|
///
|
|
bool canTrackChanges() const { return true; }
|
|
///
|
|
InsetText * asInsetText() { return this; }
|
|
///
|
|
InsetText const * asInsetText() const { return this; }
|
|
///
|
|
Text & text() { return text_; }
|
|
Text const & text() const { return text_; }
|
|
///
|
|
int latex(odocstream &, OutputParams const &) const;
|
|
///
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
|
///
|
|
int docbook(odocstream &, OutputParams const &) const;
|
|
///
|
|
docstring xhtml(XHTMLStream &, OutputParams const &) const;
|
|
///
|
|
enum XHTMLOptions {
|
|
JustText = 0,
|
|
WriteOuterTag = 1,
|
|
WriteLabel = 2,
|
|
WriteInnerTag = 4,
|
|
WriteEverything = 7
|
|
};
|
|
///
|
|
docstring insetAsXHTML(XHTMLStream &, OutputParams const &,
|
|
XHTMLOptions) const;
|
|
///
|
|
void validate(LaTeXFeatures & features) const;
|
|
|
|
/// return x,y of given position relative to the inset's baseline
|
|
void cursorPos(BufferView const & bv, CursorSlice const & sl,
|
|
bool boundary, int & x, int & y) const;
|
|
///
|
|
InsetCode lyxCode() const { return TEXT_CODE; }
|
|
///
|
|
void setText(docstring const &, Font const &, bool trackChanges);
|
|
///
|
|
void setAutoBreakRows(bool);
|
|
///
|
|
bool getAutoBreakRows() const { return text_.autoBreakRows_; }
|
|
///
|
|
void setDrawFrame(bool);
|
|
///
|
|
ColorCode frameColor() const;
|
|
///
|
|
void setFrameColor(ColorCode);
|
|
///
|
|
Text * getText(int i) const {
|
|
return (i == 0) ? const_cast<Text*>(&text_) : 0;
|
|
}
|
|
///
|
|
virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
|
|
|
|
///
|
|
void fixParagraphsFont();
|
|
|
|
/// set the change for the entire inset
|
|
void setChange(Change const & change);
|
|
/// accept the changes within the inset
|
|
void acceptChanges();
|
|
/// reject the changes within the inset
|
|
void rejectChanges();
|
|
|
|
/// append text onto the existing text
|
|
void appendParagraphs(ParagraphList &);
|
|
|
|
///
|
|
void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
|
|
|
|
///
|
|
void edit(Cursor & cur, bool front, EntryDirection entry_from);
|
|
///
|
|
Inset * editXY(Cursor & cur, int x, int y);
|
|
|
|
/// number of cells in this inset
|
|
size_t nargs() const { return 1; }
|
|
///
|
|
ParagraphList & paragraphs();
|
|
///
|
|
ParagraphList const & paragraphs() const;
|
|
///
|
|
bool insetAllowed(InsetCode) const { return !getLayout().isPassThru(); }
|
|
///
|
|
bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); }
|
|
///
|
|
virtual bool isMacroScope() const { return false; }
|
|
///
|
|
virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
|
|
///
|
|
/// should paragraphs be forced to use the empty layout?
|
|
virtual bool forcePlainLayout(idx_type = 0) const
|
|
{ return getLayout().forcePlainLayout(); }
|
|
/// should the user be allowed to customize alignment, etc.?
|
|
virtual bool allowParagraphCustomization(idx_type = 0) const
|
|
{ return getLayout().allowParagraphCustomization(); }
|
|
|
|
/// Update the counters of this inset and of its contents
|
|
virtual void updateBuffer(ParIterator const &, UpdateType);
|
|
/// the string that is passed to the TOC
|
|
void tocString(odocstream &) const;
|
|
///
|
|
void addToToc(DocIterator const &);
|
|
///
|
|
Inset * clone() const { return new InsetText(*this); }
|
|
///
|
|
bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
|
|
|
|
///
|
|
bool completionSupported(Cursor const &) const;
|
|
///
|
|
bool inlineCompletionSupported(Cursor const & cur) const;
|
|
///
|
|
bool automaticInlineCompletion() const;
|
|
///
|
|
bool automaticPopupCompletion() const;
|
|
///
|
|
bool showCompletionCursor() const;
|
|
///
|
|
CompletionList const * createCompletionList(Cursor const & cur) const;
|
|
///
|
|
docstring completionPrefix(Cursor const & cur) const;
|
|
///
|
|
bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
|
|
///
|
|
void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
|
|
/// returns the text to be used as tooltip
|
|
/// \param prefix: a string that will preced the tooltip,
|
|
/// e.g., "Index: ".
|
|
docstring toolTipText(docstring prefix = empty_docstring()) const;
|
|
|
|
///
|
|
virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
protected:
|
|
///
|
|
InsetCaption const * getCaptionInset() const;
|
|
///
|
|
docstring getCaptionText(OutputParams const &) const;
|
|
///
|
|
docstring getCaptionHTML(OutputParams const &) const;
|
|
private:
|
|
///
|
|
bool drawFrame_;
|
|
///
|
|
ColorCode frame_color_;
|
|
///
|
|
mutable pit_type old_pit;
|
|
///
|
|
mutable Text text_;
|
|
};
|
|
|
|
|
|
InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|