From b3169c12bcddf85632793cb7d23aa3985bd89b82 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Mon, 4 Apr 2011 17:55:56 +0000 Subject: [PATCH] Further commenting git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67388 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/richtext/richtextbuffer.h | 692 ++++++++++++++++----------- 1 file changed, 417 insertions(+), 275 deletions(-) diff --git a/include/wx/richtext/richtextbuffer.h b/include/wx/richtext/richtextbuffer.h index dbb7842cf4..a3ff7f5216 100644 --- a/include/wx/richtext/richtextbuffer.h +++ b/include/wx/richtext/richtextbuffer.h @@ -1110,7 +1110,7 @@ public: bool HasFloatMode() const { return HasFlag(wxTEXT_BOX_ATTR_FLOAT); } /** - Returns @true if this object is floating? + Returns @true if this object is floating. */ bool IsFloating() const { return HasFloatMode() && GetFloatMode() != wxTEXT_BOX_ATTR_FLOAT_NONE; } @@ -2521,77 +2521,92 @@ public: // Overridables - /// Hit-testing: returns a flag indicating hit test details, plus - /// information about position virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0); - /// Finds the absolute position and row height for the given character position virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart); - /// Calculate range virtual void CalculateRange(long start, long& end); - /// Delete range virtual bool DeleteRange(const wxRichTextRange& range); - /// Get any text in this object for the given range virtual wxString GetTextForRange(const wxRichTextRange& range) const; - /// Gets the object size for the given range. Returns false if the range - /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; - /// Dump to output stream for debugging virtual void Dump(wxTextOutputStream& stream); - /// Invalidate the buffer. With no argument, invalidates whole buffer. virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL); // Accessors - /// Get the children + /** + Returns the children. + */ wxRichTextObjectList& GetChildren() { return m_children; } + /** + Returns the children. + */ const wxRichTextObjectList& GetChildren() const { return m_children; } - /// Get the child count + /** + Returns the number of children. + */ size_t GetChildCount() const ; - /// Get the nth child + /** + Returns the nth child. + */ wxRichTextObject* GetChild(size_t n) const ; - /// Is this composite? + /** + Returns @true if this object is composite. + */ virtual bool IsComposite() const { return true; } - /// Returns true if the buffer is empty + /** + Returns true if the buffer is empty. + */ virtual bool IsEmpty() const { return GetChildCount() == 0; } - /// Get the child object at the given character position + /** + Returns the child object at the given character position. + */ virtual wxRichTextObject* GetChildAtPosition(long pos) const; // Operations - /// Copy void Copy(const wxRichTextCompositeObject& obj); - /// Assignment void operator= (const wxRichTextCompositeObject& obj) { Copy(obj); } - /// Append a child, returning the position + /** + Appends a child, returning the position. + */ size_t AppendChild(wxRichTextObject* child) ; - /// Insert the child in front of the given object, or at the beginning + /** + Inserts the child in front of the given object, or at the beginning. + */ bool InsertChild(wxRichTextObject* child, wxRichTextObject* inFrontOf) ; - /// Delete the child + /** + Removes and optionally deletes the specified child. + */ bool RemoveChild(wxRichTextObject* child, bool deleteChild = false) ; - /// Delete all children + /** + Deletes all the children. + */ bool DeleteChildren() ; - /// Recursively merge all pieces that can be merged. + /** + Recursively merges all pieces that can be merged. + */ bool Defragment(const wxRichTextRange& range = wxRICHTEXT_ALL); - /// Move the object recursively, by adding the offset from old to new + /** + Moves the object recursively, by adding the offset from old to new. + */ virtual void Move(const wxPoint& pt); protected: @@ -2621,302 +2636,432 @@ public: // Overridables - /// Hit-testing: returns a flag indicating hit test details, plus - /// information about position virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0); - /// Draw the item virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /// Lay the item out virtual bool Layout(wxDC& dc, const wxRect& rect, int style); - /// Gets the object size for the given range. Returns false if the range - /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; - /// Delete range virtual bool DeleteRange(const wxRichTextRange& range); - /// Get any text in this object for the given range virtual wxString GetTextForRange(const wxRichTextRange& range) const; #if wxUSE_XML - /// Import this object from XML virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse); #endif #if wxRICHTEXT_HAVE_DIRECT_OUTPUT - /// Export this object directly to the given stream. virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler); #endif #if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT - /// Export this object to the given parent node, usually creating at least one child node. virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler); #endif - /// What is the XML node name of this object? virtual wxString GetXMLNodeName() const { return wxT("paragraphlayout"); } - /// Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject - /// is possible. For example, containers supporting text, such as a text box object, can accept the focus, - /// but a table can't (set the focus to individual cells instead). virtual bool AcceptsFocus() const { return true; } // Accessors - /// Associate a control with the buffer, for operations that for example require refreshing the window. + /** + Associates a control with the buffer, for operations that for example require refreshing the window. + */ void SetRichTextCtrl(wxRichTextCtrl* ctrl) { m_ctrl = ctrl; } - /// Get the associated control. + /** + Returns the associated control. + */ wxRichTextCtrl* GetRichTextCtrl() const { return m_ctrl; } - /// Get/set whether the last paragraph is partial or complete + /** + Sets a flag indicating whether the last paragraph is partial or complete. + */ void SetPartialParagraph(bool partialPara) { m_partialParagraph = partialPara; } + + /** + Returns a flag indicating whether the last paragraph is partial or complete. + */ bool GetPartialParagraph() const { return m_partialParagraph; } - /// Returns the style sheet associated with the overall buffer. + /** + Returns the style sheet associated with the overall buffer. + */ virtual wxRichTextStyleSheet* GetStyleSheet() const; - /// Is this object top-level, i.e. with its own paragraphs, such as a text box? virtual bool IsTopLevel() const { return true; } // Operations - /// Submit command to insert paragraphs + /** + Submits a command to insert paragraphs. + */ bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0); - /// Submit command to insert the given text + /** + Submits a command to insert the given text. + */ bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0); - /// Submit command to insert the given text + /** + Submits a command to insert the given text. + */ bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0); - /// Submit command to insert the given image + /** + Submits a command to insert the given image. + */ bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags, const wxRichTextAttr& textAttr); - /// Get the style that is appropriate for a new paragraph at this position. - /// If the previous paragraph has a paragraph style name, look up the next-paragraph - /// style. + /** + Returns the style that is appropriate for a new paragraph at this position. + If the previous paragraph has a paragraph style name, looks up the next-paragraph + style. + */ wxRichTextAttr GetStyleForNewParagraph(wxRichTextBuffer* buffer, long pos, bool caretPosition = false, bool lookUpNewParaStyle=false) const; - /// Insert an object. + /** + Inserts an object. + */ wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0); - /// Submit command to delete this range + /** + Submits a command to delete this range. + */ bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer); - /// Draw the floats of this buffer + /** + Draws the floating objects in this buffer. + */ void DrawFloats(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /// Move an anchored object to another paragraph + /** + Moves an anchored object to another paragraph. + */ void MoveAnchoredObjectToParagraph(wxRichTextParagraph* from, wxRichTextParagraph* to, wxRichTextObject* obj); - /// Initialize the object. + /** + Initializes the object. + */ void Init(); - /// Clear all children + /** + Clears all the children. + */ virtual void Clear(); - /// Clear and initialize with one blank paragraph + /** + Clears and initializes with one blank paragraph. + */ virtual void Reset(); - /// Convenience function to add a paragraph of text + /** + Convenience function to add a paragraph of text. + */ virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL); - /// Convenience function to add an image + /** + Convenience function to add an image. + */ virtual wxRichTextRange AddImage(const wxImage& image, wxRichTextAttr* paraStyle = NULL); - /// Adds multiple paragraphs, based on newlines. + /** + Adds multiple paragraphs, based on newlines. + */ virtual wxRichTextRange AddParagraphs(const wxString& text, wxRichTextAttr* paraStyle = NULL); - /// Get the line at the given position. If caretPosition is true, the position is - /// a caret position, which is normally a smaller number. + /** + Returns the line at the given position. If @a caretPosition is true, the position is + a caret position, which is normally a smaller number. + */ virtual wxRichTextLine* GetLineAtPosition(long pos, bool caretPosition = false) const; - /// Get the line at the given y pixel position, or the last line. + /** + Returns the line at the given y pixel position, or the last line. + */ virtual wxRichTextLine* GetLineAtYPosition(int y) const; - /// Get the paragraph at the given character or caret position + /** + Returns the paragraph at the given character or caret position. + */ virtual wxRichTextParagraph* GetParagraphAtPosition(long pos, bool caretPosition = false) const; - /// Get the line size at the given position + /** + Returns the line size at the given position. + */ virtual wxSize GetLineSizeAtPosition(long pos, bool caretPosition = false) const; - /// Given a position, get the number of the visible line (potentially many to a paragraph), - /// starting from zero at the start of the buffer. We also have to pass a bool (startOfLine) - /// that indicates whether the caret is being shown at the end of the previous line or at the start - /// of the next, since the caret can be shown at 2 visible positions for the same underlying - /// position. + /** + Given a position, returns the number of the visible line (potentially many to a paragraph), + starting from zero at the start of the buffer. We also have to pass a bool (@a startOfLine) + that indicates whether the caret is being shown at the end of the previous line or at the start + of the next, since the caret can be shown at two visible positions for the same underlying + position. + */ virtual long GetVisibleLineNumber(long pos, bool caretPosition = false, bool startOfLine = false) const; - /// Given a line number, get the corresponding wxRichTextLine object. + /** + Given a line number, returns the corresponding wxRichTextLine object. + */ virtual wxRichTextLine* GetLineForVisibleLineNumber(long lineNumber) const; - /// Get the leaf object in a paragraph at this position. - /// Given a position, get the corresponding wxRichTextLine object. + /** + Returns the leaf object in a paragraph at this position. + */ virtual wxRichTextObject* GetLeafObjectAtPosition(long position) const; - /// Get the paragraph by number + /** + Returns the paragraph by number. + */ virtual wxRichTextParagraph* GetParagraphAtLine(long paragraphNumber) const; - /// Get the paragraph for a given line + /** + Returns the paragraph for a given line. + */ virtual wxRichTextParagraph* GetParagraphForLine(wxRichTextLine* line) const; - /// Get the length of the paragraph + /** + Returns the length of the paragraph. + */ virtual int GetParagraphLength(long paragraphNumber) const; - /// Get the number of paragraphs + /** + Returns the number of paragraphs. + */ virtual int GetParagraphCount() const { return static_cast(GetChildCount()); } - /// Get the number of visible lines + /** + Returns the number of visible lines. + */ virtual int GetLineCount() const; - /// Get the text of the paragraph + /** + Returns the text of the paragraph. + */ virtual wxString GetParagraphText(long paragraphNumber) const; - /// Convert zero-based line column and paragraph number to a position. + /** + Converts zero-based line column and paragraph number to a position. + */ virtual long XYToPosition(long x, long y) const; - /// Convert zero-based position to line column and paragraph number + /** + Converts a zero-based position to line column and paragraph number. + */ virtual bool PositionToXY(long pos, long* x, long* y) const; - /// Set text attributes: character and/or paragraph styles. + /** + Sets text attributes: character and/or paragraph styles. + */ virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - /// Set the attributes for the given object only, for example the box attributes for a text box. + /** + Sets the attributes for the given object only, for example the box attributes for a text box. + */ virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - /// Get the combined text attributes for this position. + /** + Returns the combined text attributes for this position. + */ virtual bool GetStyle(long position, wxRichTextAttr& style); - /// Get the content (uncombined) attributes for this position. + /** + Returns the content (uncombined) attributes for this position. + */ virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style); - /// Implementation helper for GetStyle. If combineStyles is true, combine base, paragraph and - /// context attributes. + /** + Implementation helper for GetStyle. If combineStyles is true, combine base, paragraph and + context attributes. + */ virtual bool DoGetStyle(long position, wxRichTextAttr& style, bool combineStyles = true); - /// Get the combined style for a range - if any attribute is different within the range, - /// that attribute is not present within the flags + /** + Returns the combined style for a range - if any attribute is different within the range, + that attribute is not present within the flags. + */ virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style); - /// Combines 'style' with 'currentStyle' for the purpose of summarising the attributes of a range of - /// content. + /** + Combines @a style with @a currentStyle for the purpose of summarising the attributes of a range of + content. + */ bool CollectStyle(wxRichTextAttr& currentStyle, const wxRichTextAttr& style, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr); - /// Set list style + /** + Set the list style. + */ virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + + /** + Set the list style. + */ virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); - /// Clear list for given range + /** + Clear the list for the given range. + */ virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - /// Number/renumber any list elements in the given range. - /// def/defName can be NULL/empty to indicate that the existing list style should be used. + /** + Number/renumber any list elements in the given range. + @a def can be NULL to indicate that the existing list style should be used. + */ virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + + /** + Number/renumber any list elements in the given range. + @a defName can be empty to indicate that the existing list style should be used. + */ virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); - /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1 - /// def/defName can be NULL/empty to indicate that the existing list style should be used. + /** + Promotes the list items within the given range. @a promoteBy can be a positive or negative number, e.g. 1 or -1. + */ virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); + + /** + Promotes the list items within the given range. @a promoteBy can be a positive or negative number, e.g. 1 or -1. + */ virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); - /// Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously - /// def/defName can be NULL/empty to indicate that the existing list style should be used. + /** + Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously + @a def can be NULL/empty to indicate that the existing list style should be used. + */ virtual bool DoNumberList(const wxRichTextRange& range, const wxRichTextRange& promotionRange, int promoteBy, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); - /// Fills in the attributes for numbering a paragraph after previousParagraph. + /** + Fills in the attributes for numbering a paragraph after previousParagraph. + */ virtual bool FindNextParagraphNumber(wxRichTextParagraph* previousParagraph, wxRichTextAttr& attr) const; - /// Test if this whole range has character attributes of the specified kind. If any - /// of the attributes are different within the range, the test fails. You - /// can use this to implement, for example, bold button updating. style must have - /// flags indicating which attributes are of interest. + /** + Test if this whole range has character attributes of the specified kind. If any + of the attributes are different within the range, the test fails. You + can use this to implement, for example, bold button updating. style must have + flags indicating which attributes are of interest. + */ virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; - /// Test if this whole range has paragraph attributes of the specified kind. If any - /// of the attributes are different within the range, the test fails. You - /// can use this to implement, for example, centering button updating. style must have - /// flags indicating which attributes are of interest. + /** + Test if this whole range has paragraph attributes of the specified kind. If any + of the attributes are different within the range, the test fails. You + can use this to implement, for example, centering button updating. style must have + flags indicating which attributes are of interest. + */ virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; - /// Clone virtual wxRichTextObject* Clone() const { return new wxRichTextParagraphLayoutBox(*this); } - /// Insert fragment into this box at the given position. If partialParagraph is true, - /// it is assumed that the last (or only) paragraph is just a piece of data with no paragraph - /// marker. + /** + Insert fragment into this box at the given position. If partialParagraph is true, + it is assumed that the last (or only) paragraph is just a piece of data with no paragraph + marker. + */ virtual bool InsertFragment(long position, wxRichTextParagraphLayoutBox& fragment); - /// Make a copy of the fragment corresponding to the given range, putting it in 'fragment'. + /** + Make a copy of the fragment corresponding to the given range, putting it in @a fragment. + */ virtual bool CopyFragment(const wxRichTextRange& range, wxRichTextParagraphLayoutBox& fragment); - /// Apply the style sheet to the buffer, for example if the styles have changed. + /** + Apply the style sheet to the buffer, for example if the styles have changed. + */ virtual bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet); - /// Copy void Copy(const wxRichTextParagraphLayoutBox& obj); - /// Assignment void operator= (const wxRichTextParagraphLayoutBox& obj) { Copy(obj); } - /// Calculate ranges + /** + Calculate ranges. + */ virtual void UpdateRanges(); - /// Get all the text + /** + Get all the text. + */ virtual wxString GetText() const; - /// Set default style for new content. Setting it to a default attribute - /// makes new content take on the 'basic' style. + /** + Sets the default style for new content. Setting it to a default attribute + makes new content take on the 'basic' style. + */ virtual bool SetDefaultStyle(const wxRichTextAttr& style); - /// Get default style + /** + Returns the default style. + */ virtual const wxRichTextAttr& GetDefaultStyle() const { return m_defaultAttributes; } - /// Set basic (overall) style + /** + Sets the basic (overall) style. + */ virtual void SetBasicStyle(const wxRichTextAttr& style) { m_attributes = style; } - /// Get basic (overall) style + /** + Returns the basic (overall) style. + */ virtual const wxRichTextAttr& GetBasicStyle() const { return m_attributes; } - /// Invalidate the buffer. With no argument, invalidates whole buffer. + /** + Invalidates the buffer. With no argument, invalidates whole buffer. + */ virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL); - /// Do the (in)validation for this object only + /** + Do the (in)validation for this object only. + */ virtual void DoInvalidate(const wxRichTextRange& invalidRange); - /// Do the (in)validation both up and down the hierarchy + /** + Do the (in)validation both up and down the hierarchy. + */ virtual void InvalidateHierarchy(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL); - /// Gather information about floating objects. If untilObj is non-NULL, - /// will stop getting information if the current object is this, since we - /// will collect the rest later. + /** + Gather information about floating objects. If untilObj is non-NULL, + will stop getting information if the current object is this, since we + will collect the rest later. + */ virtual bool UpdateFloatingObjects(const wxRect& availableRect, wxRichTextObject* untilObj = NULL); - /// Get invalid range, rounding to entire paragraphs if argument is true. + /** + Get invalid range, rounding to entire paragraphs if argument is true. + */ wxRichTextRange GetInvalidRange(bool wholeParagraphs = false) const; - /// Does this object need layout? + /** + Returns @true if this object needs layout. + */ bool IsDirty() const { return m_invalidRange != wxRICHTEXT_NONE; } - /// Get the wxRichTextFloatCollector of this object + /** + Returns the wxRichTextFloatCollector of this object. + */ wxRichTextFloatCollector* GetFloatCollector() { return m_floatCollector; } - /// Get the number of floating objects at this level + /** + Returns the number of floating objects at this level. + */ int GetFloatingObjectCount() const; - /// Get a list of floating objects + /** + Returns a list of floating objects. + */ bool GetFloatingObjects(wxRichTextObjectList& objects) const; protected: wxRichTextCtrl* m_ctrl; wxRichTextAttr m_defaultAttributes; - /// The invalidated range that will need full layout + // The invalidated range that will need full layout wxRichTextRange m_invalidRange; // Is the last paragraph partial or complete? @@ -2957,39 +3102,22 @@ public: // Overridables - /** - Draws the item. - */ - virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /** - Returns the XML node name of this object. - */ - virtual wxString GetXMLNodeName() const { return wxT("textbox"); } - /// Can we edit properties via a GUI? virtual bool CanEditProperties() const { return true; } - /// Edit properties via a GUI virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer); - /// Return the label to be used for the properties context menu item. virtual wxString GetPropertiesMenuLabel() const { return _("&Box"); } // Accessors // Operations - /** - Makes a clone of this object. - */ virtual wxRichTextObject* Clone() const { return new wxRichTextBox(*this); } - /** - Copies this object. - */ void Copy(const wxRichTextBox& obj); protected: @@ -3021,36 +3149,72 @@ public: // Accessors - /// Set the range + /** + Sets the range associated with this line. + */ void SetRange(const wxRichTextRange& range) { m_range = range; } + /** + Sets the range associated with this line. + */ void SetRange(long from, long to) { m_range = wxRichTextRange(from, to); } - /// Get the parent paragraph + /** + Returns the parent paragraph. + */ wxRichTextParagraph* GetParent() { return m_parent; } - /// Get the range + /** + Returns the range. + */ const wxRichTextRange& GetRange() const { return m_range; } + /** + Returns the range. + */ wxRichTextRange& GetRange() { return m_range; } - /// Get the absolute range + /** + Returns the absolute range. + */ wxRichTextRange GetAbsoluteRange() const; - /// Get/set the line size as calculated by Layout. + /** + Returns the line size as calculated by Layout. + */ virtual wxSize GetSize() const { return m_size; } + + /** + Sets the line size as calculated by Layout. + */ virtual void SetSize(const wxSize& sz) { m_size = sz; } - /// Get/set the object position relative to the parent + /** + Returns the object position relative to the parent. + */ virtual wxPoint GetPosition() const { return m_pos; } + + /** + Sets the object position relative to the parent. + */ virtual void SetPosition(const wxPoint& pos) { m_pos = pos; } - /// Get the absolute object position + /** + Returns the absolute object position. + */ virtual wxPoint GetAbsolutePosition() const; - /// Get the rectangle enclosing the line + /** + Returns the rectangle enclosing the line. + */ virtual wxRect GetRect() const { return wxRect(GetAbsolutePosition(), GetSize()); } - /// Set/get stored descent + /** + Sets the stored descent. + */ void SetDescent(int descent) { m_descent = descent; } + + /** + Returns the stored descent. + */ int GetDescent() const { return m_descent; } #if wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING @@ -3060,26 +3224,29 @@ public: // Operations - /// Initialisation + /** + Initialises the object. + */ void Init(wxRichTextParagraph* parent); - /// Copy + /** + Copies from @a obj. + */ void Copy(const wxRichTextLine& obj); - /// Clone virtual wxRichTextLine* Clone() const { return new wxRichTextLine(*this); } protected: - /// The range of the line (start position to end position) - /// This is relative to the parent paragraph. + // The range of the line (start position to end position) + // This is relative to the parent paragraph. wxRichTextRange m_range; - /// Size and position measured relative to top of paragraph + // Size and position measured relative to top of paragraph wxPoint m_pos; wxSize m_size; - /// Maximum descent for this line (location of text baseline) + // Maximum descent for this line (location of text baseline) int m_descent; // The parent object @@ -3109,117 +3276,156 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph: public wxRichTextCompositeObject public: // Constructors + /** + Constructor taking a parent and style. + */ wxRichTextParagraph(wxRichTextObject* parent = NULL, wxRichTextAttr* style = NULL); + /** + Constructor taking a text string, a parent and paragraph and character attributes. + */ wxRichTextParagraph(const wxString& text, wxRichTextObject* parent = NULL, wxRichTextAttr* paraStyle = NULL, wxRichTextAttr* charStyle = NULL); virtual ~wxRichTextParagraph(); wxRichTextParagraph(const wxRichTextParagraph& obj): wxRichTextCompositeObject() { Copy(obj); } // Overridables - /// Draw the item virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /// Lay the item out virtual bool Layout(wxDC& dc, const wxRect& rect, int style); - /// Gets the object size for the given range. Returns false if the range - /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; - /// Finds the absolute position and row height for the given character position virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart); - /// Hit-testing: returns a flag indicating hit test details, plus - /// information about position and the object that was found. virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0); - /// Calculate range virtual void CalculateRange(long start, long& end); - /// What is the XML node name of this object? virtual wxString GetXMLNodeName() const { return wxT("paragraph"); } // Accessors - /// Get the cached lines + /** + Returns the cached lines. + */ wxRichTextLineList& GetLines() { return m_cachedLines; } // Operations - /// Copy + /** + Copies the object. + */ void Copy(const wxRichTextParagraph& obj); - /// Clone virtual wxRichTextObject* Clone() const { return new wxRichTextParagraph(*this); } - /// Clear the cached lines + /** + Clears the cached lines. + */ void ClearLines(); // Implementation - /// Apply paragraph styles such as centering to the wrapped lines + /** + Applies paragraph styles such as centering to the wrapped lines. + */ virtual void ApplyParagraphStyle(wxRichTextLine* line, const wxRichTextAttr& attr, const wxRect& rect, wxDC& dc); - /// Insert text at the given position + /** + Inserts text at the given position. + */ virtual bool InsertText(long pos, const wxString& text); - /// Split an object at this position if necessary, and return - /// the previous object, or NULL if inserting at beginning. + /** + Splits an object at this position if necessary, and returns + the previous object, or NULL if inserting at the beginning. + */ virtual wxRichTextObject* SplitAt(long pos, wxRichTextObject** previousObject = NULL); - /// Move content to a list from this point + /** + Moves content to a list from this point. + */ virtual void MoveToList(wxRichTextObject* obj, wxList& list); - /// Add content back from list + /** + Adds content back from a list. + */ virtual void MoveFromList(wxList& list); - /// Get the plain text searching from the start or end of the range. - /// The resulting string may be shorter than the range given. + /** + Returns the plain text searching from the start or end of the range. + The resulting string may be shorter than the range given. + */ bool GetContiguousPlainText(wxString& text, const wxRichTextRange& range, bool fromStart = true); - /// Find a suitable wrap position. wrapPosition is the last position in the line to the left - /// of the split. + /** + Finds a suitable wrap position. @a wrapPosition is the last position in the line to the left + of the split. + */ bool FindWrapPosition(const wxRichTextRange& range, wxDC& dc, int availableSpace, long& wrapPosition, wxArrayInt* partialExtents); - /// Find the object at the given position + /** + Finds the object at the given position. + */ wxRichTextObject* FindObjectAtPosition(long position); - /// Get the bullet text for this paragraph. + /** + Returns the bullet text for this paragraph. + */ wxString GetBulletText(); - /// Allocate or reuse a line object + /** + Allocates or reuses a line object. + */ wxRichTextLine* AllocateLine(int pos); - /// Clear remaining unused line objects, if any + /** + Clears remaining unused line objects, if any. + */ bool ClearUnusedLines(int lineCount); - /// Get combined attributes of the base style, paragraph style and character style. We use this to dynamically - /// retrieve the actual style. + /** + Returns combined attributes of the base style, paragraph style and character style. We use this to dynamically + retrieve the actual style. + */ wxRichTextAttr GetCombinedAttributes(const wxRichTextAttr& contentStyle, bool includingBoxAttr = false) const; - /// Get combined attributes of the base style and paragraph style. + /** + Returns the combined attributes of the base style and paragraph style. + */ wxRichTextAttr GetCombinedAttributes(bool includingBoxAttr = false) const; - /// Get the first position from pos that has a line break character. + /** + Returns the first position from pos that has a line break character. + */ long GetFirstLineBreakPosition(long pos); - /// Create default tabstop array + /** + Creates a default tabstop array. + */ static void InitDefaultTabs(); - /// Clear default tabstop array + /** + Clears the default tabstop array. + */ static void ClearDefaultTabs(); - /// Get default tabstop array + /** + Returns the default tabstop array. + */ static const wxArrayInt& GetDefaultTabs() { return sm_defaultTabs; } - /// Layout the floats object + /** + Lays out the floating objects. + */ void LayoutFloat(wxDC& dc, const wxRect& rect, int style, wxRichTextFloatCollector* floatCollector); protected: - /// The lines that make up the wrapped paragraph + + // The lines that make up the wrapped paragraph wxRichTextLineList m_cachedLines; - /// Default tabstops + // Default tabstops static wxArrayInt sm_defaultTabs; friend class wxRichTextFloatCollector; @@ -3247,40 +3453,26 @@ public: // Overridables - /// Draw the item virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /// Lay the item out virtual bool Layout(wxDC& dc, const wxRect& rect, int style); - /// Gets the object size for the given range. Returns false if the range - /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; - /// Get any text in this object for the given range virtual wxString GetTextForRange(const wxRichTextRange& range) const; - /// Do a split, returning an object containing the second part, and setting - /// the first part in 'this'. virtual wxRichTextObject* DoSplit(long pos); - /// Calculate range virtual void CalculateRange(long start, long& end); - /// Delete range virtual bool DeleteRange(const wxRichTextRange& range); - /// Returns true if the object is empty virtual bool IsEmpty() const { return m_text.empty(); } - /// Returns true if this object can merge itself with the given one. virtual bool CanMerge(wxRichTextObject* object) const; - /// Returns true if this object merged itself with the given one. - /// The calling code will then delete the given object. virtual bool Merge(wxRichTextObject* object); - /// Dump to output stream for debugging virtual void Dump(wxTextOutputStream& stream); /// Get the first position from pos that has a line break character. @@ -3290,21 +3482,17 @@ public: virtual bool UsesParagraphAttributes() const { return false; } #if wxUSE_XML - /// Import this object from XML virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse); #endif #if wxRICHTEXT_HAVE_DIRECT_OUTPUT - /// Export this object directly to the given stream. virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler); #endif #if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT - /// Export this object to the given parent node, usually creating at least one child node. virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler); #endif - /// What is the XML node name of this object? virtual wxString GetXMLNodeName() const { return wxT("text"); } // Accessors @@ -3446,54 +3634,41 @@ public: // Overridables - /// Draw the item virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /// Lay the item out virtual bool Layout(wxDC& dc, const wxRect& rect, int style); - /// Get the object size for the given range. Returns false if the range - /// is invalid for this object. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; /// Get the 'natural' size for an object. For an image, it would be the /// image size. virtual wxTextAttrSize GetNaturalSize() const; - /// Returns true if the object is empty. An image is never empty; if the image is broken, that's not the same thing as empty. virtual bool IsEmpty() const { return false; /* !m_imageBlock.Ok(); */ } - /// Can we edit properties via a GUI? virtual bool CanEditProperties() const { return true; } - /// Edit properties via a GUI virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer); - /// Return the label to be used for the properties context menu item. virtual wxString GetPropertiesMenuLabel() const { return _("&Picture"); } - /// Does this object take note of paragraph attributes? Text and image objects don't. virtual bool UsesParagraphAttributes() const { return false; } #if wxUSE_XML - /// Import this object from XML virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse); #endif #if wxRICHTEXT_HAVE_DIRECT_OUTPUT - /// Export this object directly to the given stream. virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler); #endif #if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT - /// Export this object to the given parent node, usually creating at least one child node. virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler); #endif // Images can be floatable (optionally). virtual bool IsFloatable() const { return true; } - /// What is the XML node name of this object? virtual wxString GetXMLNodeName() const { return wxT("image"); } // Accessors @@ -3780,8 +3955,6 @@ public: // Implementation - /// Hit-testing: returns a flag indicating hit test details, plus - /// information about position virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0); /// Copy @@ -3951,39 +4124,22 @@ public: // Overridables - /** - Draws the item. - */ - virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - /** - Returns the XML node name of this object. - */ - virtual wxString GetXMLNodeName() const { return wxT("cell"); } - /// Can we edit properties via a GUI? virtual bool CanEditProperties() const { return true; } - /// Edit properties via a GUI virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer); - /// Return the label to be used for the properties context menu item. virtual wxString GetPropertiesMenuLabel() const { return _("&Cell"); } // Accessors // Operations - /** - Makes a clone of this object. - */ virtual wxRichTextObject* Clone() const { return new wxRichTextCell(*this); } - /** - Copies this object. - */ void Copy(const wxRichTextCell& obj); protected: @@ -4019,64 +4175,50 @@ public: // Overridables - // Draws the object. virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style); - // Returns the XML node name of this object. virtual wxString GetXMLNodeName() const { return wxT("table"); } - // Lays the object out. virtual bool Layout(wxDC& dc, const wxRect& rect, int style); - // Gets the range size. virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const; - // Deletes content in the given range. virtual bool DeleteRange(const wxRichTextRange& range); - // Gets any text in this object for the given range. virtual wxString GetTextForRange(const wxRichTextRange& range) const; #if wxUSE_XML - // Import this object from XML virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse); #endif #if wxRICHTEXT_HAVE_DIRECT_OUTPUT - // Export this object directly to the given stream. virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler); #endif #if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT - // Export this object to the given parent node, usually creating at least one child node. virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler); #endif - /// Finds the absolute position and row height for the given character position virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart); - /// Calculate range virtual void CalculateRange(long start, long& end); - /// Can this object handle the selections of its children? FOr example, a table. + // Can this object handle the selections of its children? FOr example, a table. virtual bool HandlesChildSelections() const { return true; } /// Returns a selection object specifying the selections between start and end character positions. /// For example, a table would deduce what cells (of range length 1) are selected when dragging across the table. virtual wxRichTextSelection GetSelection(long start, long end) const; - /// Can we edit properties via a GUI? virtual bool CanEditProperties() const { return true; } - /// Edit properties via a GUI virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer); - /// Return the label to be used for the properties context menu item. virtual wxString GetPropertiesMenuLabel() const { return _("&Table"); } - /// Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject - /// is possible. For example, containers supporting text, such as a text box object, can accept the focus, - /// but a table can't (set the focus to individual cells instead). + // Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject + // is possible. For example, containers supporting text, such as a text box object, can accept the focus, + // but a table can't (set the focus to individual cells instead). virtual bool AcceptsFocus() const { return false; } // Accessors -- 2.45.2