namespace lyx {
-class Buffer;
class BufferParams;
class BufferView;
+class Change;
class CompletionList;
class Cursor;
+class CursorData;
class CursorSlice;
-class DocIterator;
class ErrorList;
class Font;
class FontInfo;
class FuncRequest;
class FuncStatus;
class Inset;
+class InsetText;
class Lexer;
-class PainterInfo;
-class Spacing;
+class Paragraph;
+class ParagraphParameters;
-/// This class encapsulates the main text data and operations in LyX
+/// This class encapsulates the main text data and operations in LyX.
+/// This is more or less the private implementation of InsetText.
class Text {
-public:
- /// constructor
- explicit Text(InsetText * owner)
- : owner_(owner), autoBreakRows_(false)
- {}
+private:
+ /// Default constructor.
+ Text(InsetText * owner, bool use_default_layout);
+ /// Copy constructor.
+ Text(InsetText * owner, Text const & text);
+
+public:
/// \return true if there's no content at all.
/// \warning a non standard layout on an empty paragraph doesn't
- // count as empty.
+ /// count as empty.
bool empty() const;
/// Access to owner InsetText.
InsetText const & inset() const;
Font const & font, Font const & display_font);
/** Needed to propagate font changes to all text cells of insets
- * that are not allowed inside a font change (bug 1973).
+ * that are not allowed inside a font change (bugs 1973, 6919).
* Must not be called if \p pos denotes an ordinary character or an
* inset that is alowed inside a font change.
- * FIXME: This should be removed, see documentation of noFontChange
- * in insetbase.h
*/
void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
- Font const & font, bool toggleall = false);
+ Font const & font);
/// what you expect when pressing \<enter\> at cursor position
+ /// \param inverse_logic if false, the same layout is set for the
+ /// new paragraph if the layout is an environment; if true, the
+ /// same layout is set if it is not an environment
void breakParagraph(Cursor & cur, bool inverse_logic = false);
/// set layout over selection
void setLayout(pit_type start, pit_type end,
docstring const & layout);
- /// Set given layout to current cursor position.
- /// FIXME: replace Cursor with DocIterator.
+ /// Set given layout to current cursor position or selection.
+ /// Handles undo.
void setLayout(Cursor & cur, docstring const & layout);
/// what type of depth change to make
/// Returns whether something would be changed by changeDepth
/// FIXME: replace Cursor with DocIterator.
- bool changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const;
+ bool changeDepthAllowed(Cursor const & cur, DEPTH_CHANGE type) const;
/// Set font over selection paragraphs and rebreak.
/// FIXME: replace Cursor with DocIterator.
void setFont(Cursor & cur, Font const &, bool toggleall = false);
/// Set font from \p begin to \p end and rebreak.
void setFont(BufferView const & bv, CursorSlice const & begin,
- CursorSlice const & end, Font const &,
- bool toggleall = false);
+ CursorSlice const & end, Font const &);
///
void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
+ /// Stack to save recent text propterty applications
+ std::vector<docstring> getFreeFonts() const;
/// ???
/// FIXME: replace Cursor with DocIterator.
- docstring getStringToIndex(Cursor const & cur);
+ docstring getStringForDialog(Cursor & cur);
/// Convert the paragraphs to a string.
/// \param AsStringParameter options. This can contain any combination of
docstring asString(pit_type beg, pit_type end,
int options = AS_STR_NONE) const;
+ /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
+ /// and '\t' with spaces
+ static void shortenForOutliner(docstring & str, size_t const maxlen);
+
+ /// Appends a possibly abbreviated representation of our text to \param os,
+ /// where \param maxlen defines the maximum size of \param os. If \param
+ /// shorten is true, then os is shortened as above.
+ void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
+ /// Appends a possibly abbreviated representation of our text, from
+ /// start to end, to \param os, where \param maxlen defines the
+ /// maximum size of \param os. Omits the label of the first paragraph.
+ void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
+ bool shorten = true) const;
+
/// insert a character at cursor position
/// FIXME: replace Cursor with DocIterator.
void insertChar(Cursor & cur, char_type c);
/// read-write access to individual paragraph
Paragraph & getPar(pit_type pit) { return pars_[pit]; }
// Returns the current font and depth as a message.
- /// FIXME: replace Cursor with DocIterator.
- docstring currentState(Cursor const & cur) const;
+ // When \param devel_mode is true, add more precise information
+ docstring currentState(CursorData const & cur, bool devel_mode) const;
/** Find the word under \c from in the relative location
* defined by \c word_location.
void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
/// just selects the word the cursor is in
void selectWord(Cursor & cur, word_location loc);
+ /// expands the selection to the word the cursor is in
+ void expandWordSel(Cursor & cur);
/// select all text
void selectAll(Cursor & cur);
- /// convenience function get the previous word or an empty string
- docstring previousWord(CursorSlice const & sl) const;
-
+
/// what type of change operation to make
enum ChangeOp {
ACCEPT,
void rejectChanges();
/// returns true if par was empty and was removed
- bool setCursor(Cursor & cur, pit_type par, pos_type pos,
+ bool setCursor(Cursor & cur, pit_type pit, pos_type pos,
bool setfont = true, bool boundary = false);
///
- void setCursor(CursorSlice &, pit_type par, pos_type pos);
- ///
- void setCursorIntern(Cursor & cur, pit_type par,
+ void setCursorIntern(Cursor & cur, pit_type pit,
pos_type pos, bool setfont = true, bool boundary = false);
- ///
- void recUndo(Cursor & cur, pit_type first, pit_type last) const;
- ///
- void recUndo(Cursor & cur, pit_type first) const;
-
/// Move cursor one position backwards
/**
* Returns true if an update is needed after the move.
///
bool cursorVisRightOneWord(Cursor & cur);
/// Delete from cursor up to the end of the current or next word.
- void deleteWordForward(Cursor & cur);
+ /// Use force to skip the confirmDeletion check.
+ void deleteWordForward(Cursor & cur, bool force = false);
/// Delete from cursor to start of current or prior word.
- void deleteWordBackward(Cursor & cur);
+ void deleteWordBackward(Cursor & cur, bool force = false);
///
bool cursorUpParagraph(Cursor & cur);
///
// Dissolve the inset under cursor
/// FIXME: replace Cursor with DocIterator.
bool dissolveInset(Cursor & cur);
+ /// FIXME: replace Cursor with DocIterator.
+ bool splitInset(Cursor & cur);
///
bool selectWordWhenUnderCursor(Cursor & cur, word_location);
/// Change the case of the word at cursor position.
- void changeCase(Cursor & cur, TextCase action);
+ void changeCase(Cursor & cur, TextCase action, bool partial);
/// Transposes the character at the cursor with the one before it
void charsTranspose(Cursor & cur);
settings are given to the new one.
This function will handle a multi-paragraph selection.
*/
- void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
+ void setParagraphs(Cursor const & cur, docstring const & arg, bool merge = false);
/// Sets parameters for current or selected paragraphs
- void setParagraphs(Cursor & cur, ParagraphParameters const & p);
+ void setParagraphs(Cursor const & cur, ParagraphParameters const & p);
/* these things are for search and replace */
/// needed to insert the selection
- void insertStringAsLines(DocIterator const & dit, docstring const & str,
+ void insertStringAsLines(Cursor & cur, docstring const & str,
Font const & font);
/// needed to insert the selection
- void insertStringAsParagraphs(DocIterator const & dit, docstring const & str,
+ void insertStringAsParagraphs(Cursor & cur, docstring const & str,
Font const & font);
/// access to our paragraphs
double spacing(Paragraph const & par) const;
/// make a suggestion for a label
/// FIXME: replace Cursor with DocIterator.
- docstring getPossibleLabel(Cursor const & cur) const;
+ docstring getPossibleLabel(DocIterator const & cur) const;
/// is this paragraph right-to-left?
- bool isRTL(Paragraph const & par) const;
+ bool isRTL(pit_type pit) const;
///
bool checkAndActivateInset(Cursor & cur, bool front);
void write(std::ostream & os) const;
/// returns true if \end_document has not been read
/// insetPtr is the containing Inset
- bool read(Lexer & lex, ErrorList & errorList,
+ bool read(Lexer & lex, ErrorList & errorList,
InsetText * insetPtr);
/// delete double spaces, leading spaces, and empty paragraphs around old cursor.
/// \retval true if a change has happened and we need a redraw.
- /// FIXME: replace Cursor with DocIterator. This is not possible right
- /// now because recordUndo() is called which needs a Cursor.
+ /// Handles undo.
static bool deleteEmptyParagraphMechanism(Cursor & cur,
Cursor & old, bool & need_anchor_change);
/// delete double spaces, leading spaces, and empty paragraphs
/// from \first to \last paragraph
+ /// Does NOT handle undo (responsibility of the caller)
void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
+ /// delete double spaces, leading spaces, and empty paragraphs
+ /// from \first to \last paragraph and \first_pos to \last_pos
+ /// Does NOT handle undo (responsibility of the caller)
+ void deleteEmptyParagraphMechanism(pit_type first, pit_type last,
+ pos_type first_pos, pos_type last_pos,
+ bool trackChanges);
+
/// To resolve macros properly the texts get their DocIterator.
/// Every macro definition is stored with its DocIterator
- /// as well. Only those macros with a smaller iterator become
+ /// as well. Only those macros with a smaller iterator become
/// visible in a paragraph.
DocIterator macrocontextPosition() const;
///
bool completionSupported(Cursor const & cur) const;
///
CompletionList const * createCompletionList(Cursor const & cur) const;
- ///
- bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
+ /// Do a completion at the cursor position. Return true on success.
+ /// The completion does not contain the prefix. Handles undo.
+ bool insertCompletion(Cursor & cur, docstring const & s);
///
docstring completionPrefix(Cursor const & cur) const;
+ /// find a paragraph before \p par with the given \p depth, if such
+ /// a paragraph cannot be found, \p par is returned
+ pit_type depthHook(pit_type pit, depth_type depth) const;
+ /// find a paragraph before \p par with depth less than the
+ /// depth of \p par. If such paragraph cannot be found because
+ /// \p par already has depth 0, lastpar + 1 is returned. If
+ /// such paragraph cannot be found because there isn't a par
+ /// with less depth before this one, \p par is returned.
+ pit_type outerHook(pit_type pit) const;
+ /// Is it the first par with same depth and layout?
+ bool isFirstInSequence(pit_type pit) const;
+ /// Return the last paragraph with same depth and layout, or a strictly
+ /// greater depth
+ pit_type lastInSequence(pit_type pit) const;
+ /// Is this paragraph in the table of contents?
+ int getTocLevel(pit_type pit) const;
+ /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
+ /// All font changes of the paragraph are relative to this font.
+ Font const outerFont(pit_type pit_offset) const;
+ /// Return the label type at the end of paragraph \c pit.
+ int getEndLabel(pit_type pit) const;
private:
/// The InsetText owner shall have access to everything.
friend class InsetText;
- /// return past-the-last paragraph influenced by a layout
- /// change on pit
- pit_type undoSpan(pit_type pit);
-
- // fix the cursor `cur' after a characters has been deleted at `where'
- // position. Called by deleteEmptyParagraphMechanism
- static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
-
// At cursor position 0, try to merge the paragraph with the one before it.
// Ignore change tracking, i.e., physically remove the end-of-par character
bool backspacePos0(Cursor & cur);
/// handle the case where bibitems were deleted
bool handleBibitems(Cursor & cur);
/// are we in a list item (description etc.)?
- bool inDescriptionItem(Cursor & cur) const;
+ bool inDescriptionItem(Cursor const & cur) const;
///
void charInserted(Cursor & cur);
/// set 'number' font property
///
void readParagraph(Paragraph & par, Lexer & lex, ErrorList & errorList);
/// Set Label Width string to all paragraphs of the same layout
- /// and depth in a sequence.
- void setLabelWidthStringToSequence(pit_type const par_offset, docstring const & s);
+ /// and depth in a sequence.
+ void setLabelWidthStringToSequence(Cursor const & cur, docstring const & s);
/// Owner Inset.
InsetText * owner_;
///
ParagraphList pars_;
- ///
- bool autoBreakRows_;
/// position of the text in the buffer.
DocIterator macrocontext_position_;
};
///
void breakParagraphConservative(BufferParams const & bparams,
ParagraphList & paragraphs,
- pit_type par,
+ pit_type pit,
pos_type pos);
/**
* Be careful, this doesent make any check at all.
*/
void mergeParagraph(BufferParams const & bparams,
- ParagraphList & paragraphs, pit_type par);
-
-
-/// for the environments
-pit_type depthHook(pit_type par,
- ParagraphList const & plist, depth_type depth);
-
-pit_type outerHook(pit_type par, ParagraphList const & plist);
-
-/// Is it the first par with same depth and layout?
-bool isFirstInSequence(pit_type par, ParagraphList const & plist);
-
-/** Check if the current paragraph is the last paragraph in a
- proof environment */
-int getEndLabel(pit_type par, ParagraphList const & plist);
-
-/**
- * Get the font of the "environment" of paragraph \p par_offset in \p pars.
- * All font changes of the paragraph are relative to this font.
- */
-Font const outerFont(pit_type par_offset, ParagraphList const & pars);
+ ParagraphList & paragraphs, pit_type pit);
/// accept the changes within the complete ParagraphList
void acceptChanges(ParagraphList & pars, BufferParams const & bparams);
+/// reject the changes within the complete ParagraphList
+void rejectChanges(ParagraphList & pars, BufferParams const & bparams);
+
} // namespace lyx
#endif // TEXT_H
projects / lyx.git / blobdiff