a1b806b982
Additionally renamed wxOSX' private wxNativePrinterDC::Ok() function to IsOk(). Didn't deprecate the various Ok() functions: given the amount of changes already introduced in 3.0 a trivial one like this seems more suitable for after 3.0. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67681 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
4812 lines
147 KiB
Objective-C
4812 lines
147 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/richtext/richtextbuffer.h
|
|
// Purpose: Buffer for wxRichTextCtrl
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 2005-09-30
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_RICHTEXTBUFFER_H_
|
|
#define _WX_RICHTEXTBUFFER_H_
|
|
|
|
/*
|
|
|
|
Data structures
|
|
===============
|
|
|
|
Data is represented by a hierarchy of objects, all derived from
|
|
wxRichTextObject.
|
|
|
|
The top of the hierarchy is the buffer, a kind of wxRichTextParagraphLayoutBox.
|
|
These boxes will allow flexible placement of text boxes on a page, but
|
|
for now there is a single box representing the document, and this box is
|
|
a wxRichTextParagraphLayoutBox which contains further wxRichTextParagraph
|
|
objects, each of which can include text and images.
|
|
|
|
Each object maintains a range (start and end position) measured
|
|
from the start of the main parent box.
|
|
A paragraph object knows its range, and a text fragment knows its range
|
|
too. So, a character or image in a page has a position relative to the
|
|
start of the document, and a character in an embedded text box has
|
|
a position relative to that text box. For now, we will not be dealing with
|
|
embedded objects but it's something to bear in mind for later.
|
|
|
|
Note that internally, a range (5,5) represents a range of one character.
|
|
In the public wx[Rich]TextCtrl API, this would be passed to e.g. SetSelection
|
|
as (5,6). A paragraph with one character might have an internal range of (0, 1)
|
|
since the end of the paragraph takes up one position.
|
|
|
|
Layout
|
|
======
|
|
|
|
When Layout is called on an object, it is given a size which the object
|
|
must limit itself to, or one or more flexible directions (vertical
|
|
or horizontal). So for example a centered paragraph is given the page
|
|
width to play with (minus any margins), but can extend indefinitely
|
|
in the vertical direction. The implementation of Layout can then
|
|
cache the calculated size and position within the parent.
|
|
|
|
*/
|
|
|
|
/*!
|
|
* Includes
|
|
*/
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_RICHTEXT
|
|
|
|
#include "wx/list.h"
|
|
#include "wx/textctrl.h"
|
|
#include "wx/bitmap.h"
|
|
#include "wx/image.h"
|
|
#include "wx/cmdproc.h"
|
|
#include "wx/txtstrm.h"
|
|
#include "wx/variant.h"
|
|
|
|
#if wxUSE_DATAOBJ
|
|
#include "wx/dataobj.h"
|
|
#endif
|
|
|
|
// Compatibility
|
|
//#define wxRichTextAttr wxTextAttr
|
|
#define wxTextAttrEx wxTextAttr
|
|
|
|
// Setting wxRICHTEXT_USE_OWN_CARET to 1 implements a
|
|
// caret reliably without using wxClientDC in case there
|
|
// are platform-specific problems with the generic caret.
|
|
#if defined(__WXGTK__) || defined(__WXMAC__)
|
|
#define wxRICHTEXT_USE_OWN_CARET 1
|
|
#else
|
|
#define wxRICHTEXT_USE_OWN_CARET 0
|
|
#endif
|
|
|
|
// Switch off for binary compatibility, on for faster drawing
|
|
// Note: this seems to be buggy (overzealous use of extents) so
|
|
// don't use for now
|
|
#define wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING 0
|
|
|
|
// The following two symbols determine whether an output implementation
|
|
// is present. To switch the relevant one on, set wxRICHTEXT_USE_XMLDOCUMENT_OUTPUT in
|
|
// richtextxml.cpp. By default, the faster direct output implementation is used.
|
|
|
|
// Include the wxXmlDocument implementation for output
|
|
#define wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT 1
|
|
|
|
// Include the faster, direct implementation for output
|
|
#define wxRICHTEXT_HAVE_DIRECT_OUTPUT 1
|
|
|
|
/**
|
|
The line break character that can be embedded in content.
|
|
*/
|
|
|
|
extern WXDLLIMPEXP_RICHTEXT const wxChar wxRichTextLineBreakChar;
|
|
|
|
/**
|
|
File types in wxRichText context.
|
|
*/
|
|
enum wxRichTextFileType
|
|
{
|
|
wxRICHTEXT_TYPE_ANY = 0,
|
|
wxRICHTEXT_TYPE_TEXT,
|
|
wxRICHTEXT_TYPE_XML,
|
|
wxRICHTEXT_TYPE_HTML,
|
|
wxRICHTEXT_TYPE_RTF,
|
|
wxRICHTEXT_TYPE_PDF
|
|
};
|
|
|
|
/*
|
|
* Forward declarations
|
|
*/
|
|
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObject;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextImage;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCacheObject;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextObjectList;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextLine;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextParagraph;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextFileHandler;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleSheet;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextListStyleDefinition;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextEvent;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextRenderer;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextXMLHandler;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextParagraphLayoutBox;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextImageBlock;
|
|
class WXDLLIMPEXP_FWD_XML wxXmlNode;
|
|
class wxRichTextFloatCollector;
|
|
class WXDLLIMPEXP_FWD_BASE wxDataInputStream;
|
|
class WXDLLIMPEXP_FWD_BASE wxDataOutputStream;
|
|
|
|
/**
|
|
Flags determining the available space, passed to Layout.
|
|
*/
|
|
|
|
#define wxRICHTEXT_FIXED_WIDTH 0x01
|
|
#define wxRICHTEXT_FIXED_HEIGHT 0x02
|
|
#define wxRICHTEXT_VARIABLE_WIDTH 0x04
|
|
#define wxRICHTEXT_VARIABLE_HEIGHT 0x08
|
|
|
|
// Only lay out the part of the buffer that lies within
|
|
// the rect passed to Layout.
|
|
#define wxRICHTEXT_LAYOUT_SPECIFIED_RECT 0x10
|
|
|
|
/**
|
|
Flags to pass to Draw
|
|
*/
|
|
|
|
// Ignore paragraph cache optimization, e.g. for printing purposes
|
|
// where one line may be drawn higher (on the next page) compared
|
|
// with the previous line
|
|
#define wxRICHTEXT_DRAW_IGNORE_CACHE 0x01
|
|
#define wxRICHTEXT_DRAW_SELECTED 0x02
|
|
#define wxRICHTEXT_DRAW_PRINT 0x04
|
|
#define wxRICHTEXT_DRAW_GUIDELINES 0x08
|
|
|
|
/**
|
|
Flags returned from hit-testing, or passed to hit-test function.
|
|
*/
|
|
enum wxRichTextHitTestFlags
|
|
{
|
|
// The point was not on this object
|
|
wxRICHTEXT_HITTEST_NONE = 0x01,
|
|
|
|
// The point was before the position returned from HitTest
|
|
wxRICHTEXT_HITTEST_BEFORE = 0x02,
|
|
|
|
// The point was after the position returned from HitTest
|
|
wxRICHTEXT_HITTEST_AFTER = 0x04,
|
|
|
|
// The point was on the position returned from HitTest
|
|
wxRICHTEXT_HITTEST_ON = 0x08,
|
|
|
|
// The point was on space outside content
|
|
wxRICHTEXT_HITTEST_OUTSIDE = 0x10,
|
|
|
|
// Only do hit-testing at the current level (don't traverse into top-level objects)
|
|
wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS = 0x20,
|
|
|
|
// Ignore floating objects
|
|
wxRICHTEXT_HITTEST_NO_FLOATING_OBJECTS = 0x40
|
|
};
|
|
|
|
/**
|
|
Flags for GetRangeSize.
|
|
*/
|
|
|
|
#define wxRICHTEXT_FORMATTED 0x01
|
|
#define wxRICHTEXT_UNFORMATTED 0x02
|
|
#define wxRICHTEXT_CACHE_SIZE 0x04
|
|
#define wxRICHTEXT_HEIGHT_ONLY 0x08
|
|
|
|
/**
|
|
Flags for SetStyle/SetListStyle.
|
|
*/
|
|
|
|
#define wxRICHTEXT_SETSTYLE_NONE 0x00
|
|
|
|
// Specifies that this operation should be undoable
|
|
#define wxRICHTEXT_SETSTYLE_WITH_UNDO 0x01
|
|
|
|
// Specifies that the style should not be applied if the
|
|
// combined style at this point is already the style in question.
|
|
#define wxRICHTEXT_SETSTYLE_OPTIMIZE 0x02
|
|
|
|
// Specifies that the style should only be applied to paragraphs,
|
|
// and not the content. This allows content styling to be
|
|
// preserved independently from that of e.g. a named paragraph style.
|
|
#define wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY 0x04
|
|
|
|
// Specifies that the style should only be applied to characters,
|
|
// and not the paragraph. This allows content styling to be
|
|
// preserved independently from that of e.g. a named paragraph style.
|
|
#define wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY 0x08
|
|
|
|
// For SetListStyle only: specifies starting from the given number, otherwise
|
|
// deduces number from existing attributes
|
|
#define wxRICHTEXT_SETSTYLE_RENUMBER 0x10
|
|
|
|
// For SetListStyle only: specifies the list level for all paragraphs, otherwise
|
|
// the current indentation will be used
|
|
#define wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL 0x20
|
|
|
|
// Resets the existing style before applying the new style
|
|
#define wxRICHTEXT_SETSTYLE_RESET 0x40
|
|
|
|
// Removes the given style instead of applying it
|
|
#define wxRICHTEXT_SETSTYLE_REMOVE 0x80
|
|
|
|
/**
|
|
Flags for object insertion.
|
|
*/
|
|
|
|
#define wxRICHTEXT_INSERT_NONE 0x00
|
|
#define wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE 0x01
|
|
#define wxRICHTEXT_INSERT_INTERACTIVE 0x02
|
|
|
|
// A special flag telling the buffer to keep the first paragraph style
|
|
// as-is, when deleting a paragraph marker. In future we might pass a
|
|
// flag to InsertFragment and DeleteRange to indicate the appropriate mode.
|
|
#define wxTEXT_ATTR_KEEP_FIRST_PARA_STYLE 0x10000000
|
|
|
|
/**
|
|
Default superscript/subscript font multiplication factor.
|
|
*/
|
|
|
|
#define wxSCRIPT_MUL_FACTOR 1.5
|
|
|
|
/**
|
|
The type for wxTextAttrDimension flags.
|
|
*/
|
|
typedef unsigned short wxTextAttrDimensionFlags;
|
|
|
|
/**
|
|
Miscellaneous text box flags
|
|
*/
|
|
enum wxTextBoxAttrFlags
|
|
{
|
|
wxTEXT_BOX_ATTR_FLOAT = 0x00000001,
|
|
wxTEXT_BOX_ATTR_CLEAR = 0x00000002,
|
|
wxTEXT_BOX_ATTR_COLLAPSE_BORDERS = 0x00000004,
|
|
wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT = 0x00000008
|
|
};
|
|
|
|
/**
|
|
Whether a value is present, used in dimension flags.
|
|
*/
|
|
enum wxTextAttrValueFlags
|
|
{
|
|
wxTEXT_ATTR_VALUE_VALID = 0x1000,
|
|
wxTEXT_ATTR_VALUE_VALID_MASK = 0x1000
|
|
};
|
|
|
|
/**
|
|
Units, included in the dimension value.
|
|
*/
|
|
enum wxTextAttrUnits
|
|
{
|
|
wxTEXT_ATTR_UNITS_TENTHS_MM = 0x0001,
|
|
wxTEXT_ATTR_UNITS_PIXELS = 0x0002,
|
|
wxTEXT_ATTR_UNITS_PERCENTAGE = 0x0004,
|
|
wxTEXT_ATTR_UNITS_POINTS = 0x0008,
|
|
|
|
wxTEXT_ATTR_UNITS_MASK = 0x000F
|
|
};
|
|
|
|
/**
|
|
Position alternatives, included in the dimension flags.
|
|
*/
|
|
enum wxTextBoxAttrPosition
|
|
{
|
|
wxTEXT_BOX_ATTR_POSITION_STATIC = 0x0000, // Default is static, i.e. as per normal layout
|
|
wxTEXT_BOX_ATTR_POSITION_RELATIVE = 0x0010, // Relative to the relevant edge
|
|
wxTEXT_BOX_ATTR_POSITION_ABSOLUTE = 0x0020,
|
|
|
|
wxTEXT_BOX_ATTR_POSITION_MASK = 0x00F0
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrDimension
|
|
|
|
A class representing a rich text dimension, including units and position.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxTextAttrDimensions
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrDimension
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextAttrDimension() { Reset(); }
|
|
/**
|
|
Constructor taking value and units flag.
|
|
*/
|
|
wxTextAttrDimension(int value, wxTextAttrUnits units = wxTEXT_ATTR_UNITS_TENTHS_MM) { m_value = value; m_flags = units|wxTEXT_ATTR_VALUE_VALID; }
|
|
|
|
/**
|
|
Resets the dimension value and flags.
|
|
*/
|
|
void Reset() { m_value = 0; m_flags = 0; }
|
|
|
|
/**
|
|
Partial equality test.
|
|
*/
|
|
bool EqPartial(const wxTextAttrDimension& dim) const;
|
|
|
|
/** Apply the dimension, but not those identical to @a compareWith if present.
|
|
*/
|
|
bool Apply(const wxTextAttrDimension& dim, const wxTextAttrDimension* compareWith = NULL);
|
|
|
|
/** Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxTextAttrDimension& attr, wxTextAttrDimension& clashingAttr, wxTextAttrDimension& absentAttr);
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxTextAttrDimension& dim) const { return m_value == dim.m_value && m_flags == dim.m_flags; }
|
|
|
|
/**
|
|
Returns the integer value of the dimension.
|
|
*/
|
|
int GetValue() const { return m_value; }
|
|
|
|
/**
|
|
Returns the floating-pointing value of the dimension in mm.
|
|
|
|
*/
|
|
float GetValueMM() const { return float(m_value) / 10.0; }
|
|
|
|
/**
|
|
Sets the value of the dimension in mm.
|
|
*/
|
|
void SetValueMM(float value) { m_value = (int) ((value * 10.0) + 0.5); m_flags |= wxTEXT_ATTR_VALUE_VALID; }
|
|
|
|
/**
|
|
Sets the integer value of the dimension.
|
|
*/
|
|
void SetValue(int value) { m_value = value; m_flags |= wxTEXT_ATTR_VALUE_VALID; }
|
|
|
|
/**
|
|
Sets the integer value of the dimension, passing dimension flags.
|
|
*/
|
|
void SetValue(int value, wxTextAttrDimensionFlags flags) { SetValue(value); m_flags = flags; }
|
|
|
|
/**
|
|
Sets the integer value and units.
|
|
*/
|
|
void SetValue(int value, wxTextAttrUnits units) { m_value = value; m_flags = units | wxTEXT_ATTR_VALUE_VALID; }
|
|
|
|
/**
|
|
Sets the dimension.
|
|
*/
|
|
void SetValue(const wxTextAttrDimension& dim) { (*this) = dim; }
|
|
|
|
/**
|
|
Gets the units of the dimension.
|
|
*/
|
|
wxTextAttrUnits GetUnits() const { return (wxTextAttrUnits) (m_flags & wxTEXT_ATTR_UNITS_MASK); }
|
|
|
|
/**
|
|
Sets the units of the dimension.
|
|
*/
|
|
void SetUnits(wxTextAttrUnits units) { m_flags &= ~wxTEXT_ATTR_UNITS_MASK; m_flags |= units; }
|
|
|
|
/**
|
|
Gets the position flags.
|
|
*/
|
|
wxTextBoxAttrPosition GetPosition() const { return (wxTextBoxAttrPosition) (m_flags & wxTEXT_BOX_ATTR_POSITION_MASK); }
|
|
|
|
/**
|
|
Sets the position flags.
|
|
*/
|
|
void SetPosition(wxTextBoxAttrPosition pos) { m_flags &= ~wxTEXT_BOX_ATTR_POSITION_MASK; m_flags |= pos; }
|
|
|
|
/**
|
|
Returns @true if the dimension is valid.
|
|
*/
|
|
bool IsValid() const { return (m_flags & wxTEXT_ATTR_VALUE_VALID) != 0; }
|
|
|
|
/**
|
|
Sets the valid flag.
|
|
*/
|
|
void SetValid(bool b) { m_flags &= ~wxTEXT_ATTR_VALUE_VALID_MASK; m_flags |= (b ? wxTEXT_ATTR_VALUE_VALID : 0); }
|
|
|
|
/**
|
|
Gets the dimension flags.
|
|
*/
|
|
wxTextAttrDimensionFlags GetFlags() const { return m_flags; }
|
|
|
|
/**
|
|
Sets the dimension flags.
|
|
*/
|
|
void SetFlags(wxTextAttrDimensionFlags flags) { m_flags = flags; }
|
|
|
|
int m_value;
|
|
wxTextAttrDimensionFlags m_flags;
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrDimensions
|
|
A class for left, right, top and bottom dimensions.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxTextAttrDimension
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrDimensions
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextAttrDimensions() {}
|
|
|
|
/**
|
|
Resets the value and flags for all dimensions.
|
|
*/
|
|
void Reset() { m_left.Reset(); m_top.Reset(); m_right.Reset(); m_bottom.Reset(); }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxTextAttrDimensions& dims) const { return m_left == dims.m_left && m_top == dims.m_top && m_right == dims.m_right && m_bottom == dims.m_bottom; }
|
|
|
|
/**
|
|
Partial equality test.
|
|
|
|
*/
|
|
bool EqPartial(const wxTextAttrDimensions& dims) const;
|
|
|
|
/**
|
|
Apply border to 'this', but not if the same as @a compareWith.
|
|
|
|
*/
|
|
bool Apply(const wxTextAttrDimensions& dims, const wxTextAttrDimensions* compareWith = NULL);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
|
|
*/
|
|
void CollectCommonAttributes(const wxTextAttrDimensions& attr, wxTextAttrDimensions& clashingAttr, wxTextAttrDimensions& absentAttr);
|
|
|
|
/**
|
|
Remove specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxTextAttrDimensions& attr);
|
|
|
|
/**
|
|
Gets the left dimension.
|
|
*/
|
|
const wxTextAttrDimension& GetLeft() const { return m_left; }
|
|
wxTextAttrDimension& GetLeft() { return m_left; }
|
|
|
|
/**
|
|
Gets the right dimension.
|
|
|
|
*/
|
|
const wxTextAttrDimension& GetRight() const { return m_right; }
|
|
wxTextAttrDimension& GetRight() { return m_right; }
|
|
|
|
/**
|
|
Gets the top dimension.
|
|
|
|
*/
|
|
const wxTextAttrDimension& GetTop() const { return m_top; }
|
|
wxTextAttrDimension& GetTop() { return m_top; }
|
|
|
|
/**
|
|
Gets the bottom dimension.
|
|
|
|
*/
|
|
const wxTextAttrDimension& GetBottom() const { return m_bottom; }
|
|
wxTextAttrDimension& GetBottom() { return m_bottom; }
|
|
|
|
wxTextAttrDimension m_left;
|
|
wxTextAttrDimension m_top;
|
|
wxTextAttrDimension m_right;
|
|
wxTextAttrDimension m_bottom;
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrSize
|
|
A class for representing width and height.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxTextAttrDimension
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrSize
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextAttrSize() {}
|
|
|
|
/**
|
|
Resets the width and height dimensions.
|
|
*/
|
|
void Reset() { m_width.Reset(); m_height.Reset(); }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxTextAttrSize& size) const { return m_width == size.m_width && m_height == size.m_height ; }
|
|
|
|
/**
|
|
Partial equality test.
|
|
*/
|
|
bool EqPartial(const wxTextAttrSize& dims) const;
|
|
|
|
/**
|
|
Apply border to this object, but not if the same as @a compareWith.
|
|
*/
|
|
bool Apply(const wxTextAttrSize& dims, const wxTextAttrSize* compareWith = NULL);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxTextAttrSize& attr, wxTextAttrSize& clashingAttr, wxTextAttrSize& absentAttr);
|
|
|
|
/**
|
|
Removes the specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxTextAttrSize& attr);
|
|
|
|
/**
|
|
Returns the width.
|
|
*/
|
|
wxTextAttrDimension& GetWidth() { return m_width; }
|
|
const wxTextAttrDimension& GetWidth() const { return m_width; }
|
|
|
|
/**
|
|
Sets the width.
|
|
*/
|
|
void SetWidth(int value, wxTextAttrDimensionFlags flags) { m_width.SetValue(value, flags); }
|
|
/**
|
|
Sets the width.
|
|
*/
|
|
void SetWidth(int value, wxTextAttrUnits units) { m_width.SetValue(value, units); }
|
|
/**
|
|
Sets the width.
|
|
*/
|
|
void SetWidth(const wxTextAttrDimension& dim) { m_width.SetValue(dim); }
|
|
|
|
/**
|
|
Gets the height.
|
|
*/
|
|
wxTextAttrDimension& GetHeight() { return m_height; }
|
|
const wxTextAttrDimension& GetHeight() const { return m_height; }
|
|
|
|
/**
|
|
Sets the height.
|
|
*/
|
|
void SetHeight(int value, wxTextAttrDimensionFlags flags) { m_height.SetValue(value, flags); }
|
|
/**
|
|
Sets the height.
|
|
*/
|
|
void SetHeight(int value, wxTextAttrUnits units) { m_height.SetValue(value, units); }
|
|
/**
|
|
Sets the height.
|
|
*/
|
|
void SetHeight(const wxTextAttrDimension& dim) { m_height.SetValue(dim); }
|
|
|
|
wxTextAttrDimension m_width;
|
|
wxTextAttrDimension m_height;
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrDimensionConverter
|
|
A class to make it easier to convert dimensions.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxTextAttrDimension
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrDimensionConverter
|
|
{
|
|
public:
|
|
/**
|
|
Constructor.
|
|
*/
|
|
wxTextAttrDimensionConverter(wxDC& dc, double scale = 1.0, const wxSize& parentSize = wxDefaultSize);
|
|
/**
|
|
Constructor.
|
|
*/
|
|
wxTextAttrDimensionConverter(int ppi, double scale = 1.0, const wxSize& parentSize = wxDefaultSize);
|
|
|
|
/**
|
|
Gets the pixel size for the given dimension.
|
|
*/
|
|
int GetPixels(const wxTextAttrDimension& dim, int direction = wxHORIZONTAL) const;
|
|
/**
|
|
Gets the mm size for the given dimension.
|
|
*/
|
|
int GetTenthsMM(const wxTextAttrDimension& dim) const;
|
|
|
|
/**
|
|
Converts tenths of a mm to pixels.
|
|
*/
|
|
int ConvertTenthsMMToPixels(int units) const;
|
|
/**
|
|
Converts pixels to tenths of a mm.
|
|
*/
|
|
int ConvertPixelsToTenthsMM(int pixels) const;
|
|
|
|
int m_ppi;
|
|
double m_scale;
|
|
wxSize m_parentSize;
|
|
};
|
|
|
|
/**
|
|
Border styles, used with wxTextAttrBorder.
|
|
*/
|
|
enum wxTextAttrBorderStyle
|
|
{
|
|
wxTEXT_BOX_ATTR_BORDER_NONE = 0,
|
|
wxTEXT_BOX_ATTR_BORDER_SOLID = 1,
|
|
wxTEXT_BOX_ATTR_BORDER_DOTTED = 2,
|
|
wxTEXT_BOX_ATTR_BORDER_DASHED = 3,
|
|
wxTEXT_BOX_ATTR_BORDER_DOUBLE = 4,
|
|
wxTEXT_BOX_ATTR_BORDER_GROOVE = 5,
|
|
wxTEXT_BOX_ATTR_BORDER_RIDGE = 6,
|
|
wxTEXT_BOX_ATTR_BORDER_INSET = 7,
|
|
wxTEXT_BOX_ATTR_BORDER_OUTSET = 8
|
|
};
|
|
|
|
/**
|
|
Border style presence flags, used with wxTextAttrBorder.
|
|
*/
|
|
enum wxTextAttrBorderFlags
|
|
{
|
|
wxTEXT_BOX_ATTR_BORDER_STYLE = 0x0001,
|
|
wxTEXT_BOX_ATTR_BORDER_COLOUR = 0x0002
|
|
};
|
|
|
|
/**
|
|
Border width symbols for qualitative widths, used with wxTextAttrBorder.
|
|
*/
|
|
enum wxTextAttrBorderWidth
|
|
{
|
|
wxTEXT_BOX_ATTR_BORDER_THIN = -1,
|
|
wxTEXT_BOX_ATTR_BORDER_MEDIUM = -2,
|
|
wxTEXT_BOX_ATTR_BORDER_THICK = -3
|
|
};
|
|
|
|
/**
|
|
Float styles.
|
|
*/
|
|
enum wxTextBoxAttrFloatStyle
|
|
{
|
|
wxTEXT_BOX_ATTR_FLOAT_NONE = 0,
|
|
wxTEXT_BOX_ATTR_FLOAT_LEFT = 1,
|
|
wxTEXT_BOX_ATTR_FLOAT_RIGHT = 2
|
|
};
|
|
|
|
/**
|
|
Clear styles.
|
|
*/
|
|
enum wxTextBoxAttrClearStyle
|
|
{
|
|
wxTEXT_BOX_ATTR_CLEAR_NONE = 0,
|
|
wxTEXT_BOX_ATTR_CLEAR_LEFT = 1,
|
|
wxTEXT_BOX_ATTR_CLEAR_RIGHT = 2,
|
|
wxTEXT_BOX_ATTR_CLEAR_BOTH = 3
|
|
};
|
|
|
|
/**
|
|
Collapse mode styles. TODO: can they be switched on per side?
|
|
*/
|
|
enum wxTextBoxAttrCollapseMode
|
|
{
|
|
wxTEXT_BOX_ATTR_COLLAPSE_NONE = 0,
|
|
wxTEXT_BOX_ATTR_COLLAPSE_FULL = 1
|
|
};
|
|
|
|
/**
|
|
Vertical alignment values.
|
|
*/
|
|
enum wxTextBoxAttrVerticalAlignment
|
|
{
|
|
wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_NONE = 0,
|
|
wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_TOP = 1,
|
|
wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_CENTRE = 2,
|
|
wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT_BOTTOM = 3
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrBorder
|
|
A class representing a rich text object border.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxRichTextAttrBorders
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrBorder
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextAttrBorder() { Reset(); }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxTextAttrBorder& border) const
|
|
{
|
|
return m_flags == border.m_flags && m_borderStyle == border.m_borderStyle &&
|
|
m_borderColour == border.m_borderColour && m_borderWidth == border.m_borderWidth;
|
|
}
|
|
|
|
/**
|
|
Resets the border style, colour, width and flags.
|
|
*/
|
|
void Reset() { m_borderStyle = 0; m_borderColour = 0; m_flags = 0; m_borderWidth.Reset(); }
|
|
|
|
/**
|
|
Partial equality test.
|
|
*/
|
|
bool EqPartial(const wxTextAttrBorder& border) const;
|
|
|
|
/**
|
|
Applies the border to this object, but not if the same as @a compareWith.
|
|
|
|
*/
|
|
bool Apply(const wxTextAttrBorder& border, const wxTextAttrBorder* compareWith = NULL);
|
|
|
|
/**
|
|
Removes the specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxTextAttrBorder& attr);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxTextAttrBorder& attr, wxTextAttrBorder& clashingAttr, wxTextAttrBorder& absentAttr);
|
|
|
|
/**
|
|
Sets the border style.
|
|
*/
|
|
void SetStyle(int style) { m_borderStyle = style; m_flags |= wxTEXT_BOX_ATTR_BORDER_STYLE; }
|
|
|
|
/**
|
|
Gets the border style.
|
|
|
|
*/
|
|
int GetStyle() const { return m_borderStyle; }
|
|
|
|
/**
|
|
Sets the border colour.
|
|
*/
|
|
void SetColour(unsigned long colour) { m_borderColour = colour; m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; }
|
|
|
|
/**
|
|
Sets the border colour.
|
|
*/
|
|
void SetColour(const wxColour& colour) { m_borderColour = colour.GetRGB(); m_flags |= wxTEXT_BOX_ATTR_BORDER_COLOUR; }
|
|
|
|
/**
|
|
Gets the colour as a long.
|
|
*/
|
|
unsigned long GetColourLong() const { return m_borderColour; }
|
|
|
|
/**
|
|
Gets the colour.
|
|
*/
|
|
wxColour GetColour() const { return wxColour(m_borderColour); }
|
|
|
|
/**
|
|
Gets the border width.
|
|
*/
|
|
wxTextAttrDimension& GetWidth() { return m_borderWidth; }
|
|
const wxTextAttrDimension& GetWidth() const { return m_borderWidth; }
|
|
|
|
/**
|
|
Sets the border width.
|
|
*/
|
|
void SetWidth(const wxTextAttrDimension& width) { m_borderWidth = width; }
|
|
/**
|
|
Sets the border width.
|
|
*/
|
|
void SetWidth(int value, wxTextAttrUnits units = wxTEXT_ATTR_UNITS_TENTHS_MM) { SetWidth(wxTextAttrDimension(value, units)); }
|
|
|
|
/**
|
|
True if the border has a valid style.
|
|
*/
|
|
bool HasStyle() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_STYLE) != 0; }
|
|
|
|
/**
|
|
True if the border has a valid colour.
|
|
*/
|
|
bool HasColour() const { return (m_flags & wxTEXT_BOX_ATTR_BORDER_COLOUR) != 0; }
|
|
|
|
/**
|
|
True if the border has a valid width.
|
|
*/
|
|
bool HasWidth() const { return m_borderWidth.IsValid(); }
|
|
|
|
/**
|
|
True if the border is valid.
|
|
*/
|
|
bool IsValid() const { return HasWidth(); }
|
|
|
|
/**
|
|
Set the valid flag for this border.
|
|
*/
|
|
void MakeValid() { m_borderWidth.SetValid(true); }
|
|
|
|
/**
|
|
Returns the border flags.
|
|
*/
|
|
int GetFlags() const { return m_flags; }
|
|
|
|
/**
|
|
Sets the border flags.
|
|
*/
|
|
void SetFlags(int flags) { m_flags = flags; }
|
|
|
|
/**
|
|
Adds a border flag.
|
|
*/
|
|
void AddFlag(int flag) { m_flags |= flag; }
|
|
|
|
/**
|
|
Removes a border flag.
|
|
*/
|
|
void RemoveFlag(int flag) { m_flags &= ~flag; }
|
|
|
|
int m_borderStyle;
|
|
unsigned long m_borderColour;
|
|
wxTextAttrDimension m_borderWidth;
|
|
int m_flags;
|
|
};
|
|
|
|
/**
|
|
@class wxTextAttrBorders
|
|
A class representing a rich text object's borders.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl, wxRichTextAttrBorder
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextAttrBorders
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextAttrBorders() { }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxTextAttrBorders& borders) const
|
|
{
|
|
return m_left == borders.m_left && m_right == borders.m_right &&
|
|
m_top == borders.m_top && m_bottom == borders.m_bottom;
|
|
}
|
|
|
|
/**
|
|
Sets the style of all borders.
|
|
*/
|
|
void SetStyle(int style);
|
|
|
|
/**
|
|
Sets colour of all borders.
|
|
*/
|
|
void SetColour(unsigned long colour);
|
|
|
|
/**
|
|
Sets the colour for all borders.
|
|
*/
|
|
void SetColour(const wxColour& colour);
|
|
|
|
/**
|
|
Sets the width of all borders.
|
|
*/
|
|
void SetWidth(const wxTextAttrDimension& width);
|
|
|
|
/**
|
|
Sets the width of all borders.
|
|
*/
|
|
void SetWidth(int value, wxTextAttrUnits units = wxTEXT_ATTR_UNITS_TENTHS_MM) { SetWidth(wxTextAttrDimension(value, units)); }
|
|
|
|
/**
|
|
Resets all borders.
|
|
*/
|
|
void Reset() { m_left.Reset(); m_right.Reset(); m_top.Reset(); m_bottom.Reset(); }
|
|
|
|
/**
|
|
Partial equality test.
|
|
*/
|
|
bool EqPartial(const wxTextAttrBorders& borders) const;
|
|
|
|
/**
|
|
Applies border to this object, but not if the same as @a compareWith.
|
|
*/
|
|
bool Apply(const wxTextAttrBorders& borders, const wxTextAttrBorders* compareWith = NULL);
|
|
|
|
/**
|
|
Removes the specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxTextAttrBorders& attr);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxTextAttrBorders& attr, wxTextAttrBorders& clashingAttr, wxTextAttrBorders& absentAttr);
|
|
|
|
/**
|
|
Returns @true if all borders are valid.
|
|
*/
|
|
bool IsValid() const { return m_left.IsValid() || m_right.IsValid() || m_top.IsValid() || m_bottom.IsValid(); }
|
|
|
|
/**
|
|
Returns the left border.
|
|
*/
|
|
const wxTextAttrBorder& GetLeft() const { return m_left; }
|
|
wxTextAttrBorder& GetLeft() { return m_left; }
|
|
|
|
/**
|
|
Returns the right border.
|
|
*/
|
|
const wxTextAttrBorder& GetRight() const { return m_right; }
|
|
wxTextAttrBorder& GetRight() { return m_right; }
|
|
|
|
/**
|
|
Returns the top border.
|
|
*/
|
|
const wxTextAttrBorder& GetTop() const { return m_top; }
|
|
wxTextAttrBorder& GetTop() { return m_top; }
|
|
|
|
/**
|
|
Returns the bottom border.
|
|
*/
|
|
const wxTextAttrBorder& GetBottom() const { return m_bottom; }
|
|
wxTextAttrBorder& GetBottom() { return m_bottom; }
|
|
|
|
wxTextAttrBorder m_left, m_right, m_top, m_bottom;
|
|
|
|
};
|
|
|
|
/**
|
|
@class wxTextBoxAttr
|
|
A class representing the box attributes of a rich text object.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxTextBoxAttr
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxTextBoxAttr() { Init(); }
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxTextBoxAttr(const wxTextBoxAttr& attr) { Init(); (*this) = attr; }
|
|
|
|
/**
|
|
Initialises this object.
|
|
*/
|
|
void Init() { Reset(); }
|
|
|
|
/**
|
|
Resets this object.
|
|
*/
|
|
void Reset();
|
|
|
|
// Copy. Unnecessary since we let it do a binary copy
|
|
//void Copy(const wxTextBoxAttr& attr);
|
|
|
|
// Assignment
|
|
//void operator= (const wxTextBoxAttr& attr);
|
|
|
|
/**
|
|
Equality test.
|
|
*/
|
|
bool operator== (const wxTextBoxAttr& attr) const;
|
|
|
|
/**
|
|
Partial equality test, ignoring unset attributes.
|
|
|
|
*/
|
|
bool EqPartial(const wxTextBoxAttr& attr) const;
|
|
|
|
/**
|
|
Merges the given attributes. If @a compareWith is non-NULL, then it will be used
|
|
to mask out those attributes that are the same in style and @a compareWith, for
|
|
situations where we don't want to explicitly set inherited attributes.
|
|
*/
|
|
bool Apply(const wxTextBoxAttr& style, const wxTextBoxAttr* compareWith = NULL);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxTextBoxAttr& attr, wxTextBoxAttr& clashingAttr, wxTextBoxAttr& absentAttr);
|
|
|
|
/**
|
|
Removes the specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxTextBoxAttr& attr);
|
|
|
|
/**
|
|
Sets the flags.
|
|
*/
|
|
void SetFlags(int flags) { m_flags = flags; }
|
|
|
|
/**
|
|
Returns the flags.
|
|
*/
|
|
int GetFlags() const { return m_flags; }
|
|
|
|
/**
|
|
Is this flag present?
|
|
*/
|
|
bool HasFlag(wxTextBoxAttrFlags flag) const { return (m_flags & flag) != 0; }
|
|
|
|
/**
|
|
Removes this flag.
|
|
*/
|
|
void RemoveFlag(wxTextBoxAttrFlags flag) { m_flags &= ~flag; }
|
|
|
|
/**
|
|
Adds this flag.
|
|
*/
|
|
void AddFlag(wxTextBoxAttrFlags flag) { m_flags |= flag; }
|
|
|
|
/**
|
|
Returns @true if no attributes are set.
|
|
*/
|
|
bool IsDefault() const;
|
|
|
|
/**
|
|
Returns the float mode.
|
|
*/
|
|
wxTextBoxAttrFloatStyle GetFloatMode() const { return m_floatMode; }
|
|
|
|
/**
|
|
Sets the float mode.
|
|
*/
|
|
void SetFloatMode(wxTextBoxAttrFloatStyle mode) { m_floatMode = mode; m_flags |= wxTEXT_BOX_ATTR_FLOAT; }
|
|
|
|
/**
|
|
Returns @true if float mode is active.
|
|
*/
|
|
bool HasFloatMode() const { return HasFlag(wxTEXT_BOX_ATTR_FLOAT); }
|
|
|
|
/**
|
|
Returns @true if this object is floating.
|
|
*/
|
|
bool IsFloating() const { return HasFloatMode() && GetFloatMode() != wxTEXT_BOX_ATTR_FLOAT_NONE; }
|
|
|
|
/**
|
|
Returns the clear mode - whether to wrap text after object. Currently unimplemented.
|
|
*/
|
|
wxTextBoxAttrClearStyle GetClearMode() const { return m_clearMode; }
|
|
|
|
/**
|
|
Set the clear mode. Currently unimplemented.
|
|
*/
|
|
void SetClearMode(wxTextBoxAttrClearStyle mode) { m_clearMode = mode; m_flags |= wxTEXT_BOX_ATTR_CLEAR; }
|
|
|
|
/**
|
|
Returns @true if we have a clear flag.
|
|
*/
|
|
bool HasClearMode() const { return HasFlag(wxTEXT_BOX_ATTR_CLEAR); }
|
|
|
|
/**
|
|
Returns the collapse mode - whether to collapse borders. Currently unimplemented.
|
|
*/
|
|
wxTextBoxAttrCollapseMode GetCollapseBorders() const { return m_collapseMode; }
|
|
|
|
/**
|
|
Sets the collapse mode - whether to collapse borders. Currently unimplemented.
|
|
*/
|
|
void SetCollapseBorders(wxTextBoxAttrCollapseMode collapse) { m_collapseMode = collapse; m_flags |= wxTEXT_BOX_ATTR_COLLAPSE_BORDERS; }
|
|
|
|
/**
|
|
Returns @true if the collapse borders flag is present.
|
|
*/
|
|
bool HasCollapseBorders() const { return HasFlag(wxTEXT_BOX_ATTR_COLLAPSE_BORDERS); }
|
|
|
|
/**
|
|
Returns the vertical alignment.
|
|
*/
|
|
wxTextBoxAttrVerticalAlignment GetVerticalAlignment() const { return m_verticalAlignment; }
|
|
|
|
/**
|
|
Sets the vertical alignment.
|
|
*/
|
|
void SetVerticalAlignment(wxTextBoxAttrVerticalAlignment verticalAlignment) { m_verticalAlignment = verticalAlignment; m_flags |= wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT; }
|
|
|
|
/**
|
|
Returns @true if a vertical alignment flag is present.
|
|
*/
|
|
bool HasVerticalAlignment() const { return HasFlag(wxTEXT_BOX_ATTR_VERTICAL_ALIGNMENT); }
|
|
|
|
/**
|
|
Returns the margin values.
|
|
*/
|
|
wxTextAttrDimensions& GetMargins() { return m_margins; }
|
|
const wxTextAttrDimensions& GetMargins() const { return m_margins; }
|
|
|
|
/**
|
|
Returns the left margin.
|
|
*/
|
|
wxTextAttrDimension& GetLeftMargin() { return m_margins.m_left; }
|
|
const wxTextAttrDimension& GetLeftMargin() const { return m_margins.m_left; }
|
|
|
|
/**
|
|
Returns the right margin.
|
|
*/
|
|
wxTextAttrDimension& GetRightMargin() { return m_margins.m_right; }
|
|
const wxTextAttrDimension& GetRightMargin() const { return m_margins.m_right; }
|
|
|
|
/**
|
|
Returns the top margin.
|
|
*/
|
|
wxTextAttrDimension& GetTopMargin() { return m_margins.m_top; }
|
|
const wxTextAttrDimension& GetTopMargin() const { return m_margins.m_top; }
|
|
|
|
/**
|
|
Returns the bottom margin.
|
|
*/
|
|
wxTextAttrDimension& GetBottomMargin() { return m_margins.m_bottom; }
|
|
const wxTextAttrDimension& GetBottomMargin() const { return m_margins.m_bottom; }
|
|
|
|
/**
|
|
Returns the position.
|
|
*/
|
|
wxTextAttrDimensions& GetPosition() { return m_position; }
|
|
const wxTextAttrDimensions& GetPosition() const { return m_position; }
|
|
|
|
/**
|
|
Returns the left position.
|
|
*/
|
|
wxTextAttrDimension& GetLeft() { return m_position.m_left; }
|
|
const wxTextAttrDimension& GetLeft() const { return m_position.m_left; }
|
|
|
|
/**
|
|
Returns the right position.
|
|
*/
|
|
wxTextAttrDimension& GetRight() { return m_position.m_right; }
|
|
const wxTextAttrDimension& GetRight() const { return m_position.m_right; }
|
|
|
|
/**
|
|
Returns the top position.
|
|
*/
|
|
wxTextAttrDimension& GetTop() { return m_position.m_top; }
|
|
const wxTextAttrDimension& GetTop() const { return m_position.m_top; }
|
|
|
|
/**
|
|
Returns the bottom position.
|
|
*/
|
|
wxTextAttrDimension& GetBottom() { return m_position.m_bottom; }
|
|
const wxTextAttrDimension& GetBottom() const { return m_position.m_bottom; }
|
|
|
|
/**
|
|
Returns the padding values.
|
|
*/
|
|
wxTextAttrDimensions& GetPadding() { return m_padding; }
|
|
const wxTextAttrDimensions& GetPadding() const { return m_padding; }
|
|
|
|
/**
|
|
Returns the left padding value.
|
|
*/
|
|
wxTextAttrDimension& GetLeftPadding() { return m_padding.m_left; }
|
|
const wxTextAttrDimension& GetLeftPadding() const { return m_padding.m_left; }
|
|
|
|
/**
|
|
Returns the right padding value.
|
|
*/
|
|
wxTextAttrDimension& GetRightPadding() { return m_padding.m_right; }
|
|
const wxTextAttrDimension& GetRightPadding() const { return m_padding.m_right; }
|
|
|
|
/**
|
|
Returns the top padding value.
|
|
*/
|
|
wxTextAttrDimension& GetTopPadding() { return m_padding.m_top; }
|
|
const wxTextAttrDimension& GetTopPadding() const { return m_padding.m_top; }
|
|
|
|
/**
|
|
Returns the bottom padding value.
|
|
*/
|
|
wxTextAttrDimension& GetBottomPadding() { return m_padding.m_bottom; }
|
|
const wxTextAttrDimension& GetBottomPadding() const { return m_padding.m_bottom; }
|
|
|
|
/**
|
|
Returns the borders.
|
|
*/
|
|
wxTextAttrBorders& GetBorder() { return m_border; }
|
|
const wxTextAttrBorders& GetBorder() const { return m_border; }
|
|
|
|
/**
|
|
Returns the left border.
|
|
*/
|
|
wxTextAttrBorder& GetLeftBorder() { return m_border.m_left; }
|
|
const wxTextAttrBorder& GetLeftBorder() const { return m_border.m_left; }
|
|
|
|
/**
|
|
Returns the top border.
|
|
*/
|
|
wxTextAttrBorder& GetTopBorder() { return m_border.m_top; }
|
|
const wxTextAttrBorder& GetTopBorder() const { return m_border.m_top; }
|
|
|
|
/**
|
|
Returns the right border.
|
|
*/
|
|
wxTextAttrBorder& GetRightBorder() { return m_border.m_right; }
|
|
const wxTextAttrBorder& GetRightBorder() const { return m_border.m_right; }
|
|
|
|
/**
|
|
Returns the bottom border.
|
|
*/
|
|
wxTextAttrBorder& GetBottomBorder() { return m_border.m_bottom; }
|
|
const wxTextAttrBorder& GetBottomBorder() const { return m_border.m_bottom; }
|
|
|
|
/**
|
|
Returns the outline.
|
|
*/
|
|
wxTextAttrBorders& GetOutline() { return m_outline; }
|
|
const wxTextAttrBorders& GetOutline() const { return m_outline; }
|
|
|
|
/**
|
|
Returns the left outline.
|
|
*/
|
|
wxTextAttrBorder& GetLeftOutline() { return m_outline.m_left; }
|
|
const wxTextAttrBorder& GetLeftOutline() const { return m_outline.m_left; }
|
|
|
|
/**
|
|
Returns the top outline.
|
|
*/
|
|
wxTextAttrBorder& GetTopOutline() { return m_outline.m_top; }
|
|
const wxTextAttrBorder& GetTopOutline() const { return m_outline.m_top; }
|
|
|
|
/**
|
|
Returns the right outline.
|
|
*/
|
|
wxTextAttrBorder& GetRightOutline() { return m_outline.m_right; }
|
|
const wxTextAttrBorder& GetRightOutline() const { return m_outline.m_right; }
|
|
|
|
/**
|
|
Returns the bottom outline.
|
|
*/
|
|
wxTextAttrBorder& GetBottomOutline() { return m_outline.m_bottom; }
|
|
const wxTextAttrBorder& GetBottomOutline() const { return m_outline.m_bottom; }
|
|
|
|
/**
|
|
Returns the object size.
|
|
*/
|
|
wxTextAttrSize& GetSize() { return m_size; }
|
|
const wxTextAttrSize& GetSize() const { return m_size; }
|
|
|
|
/**
|
|
Sets the object size.
|
|
*/
|
|
void SetSize(const wxTextAttrSize& sz) { m_size = sz; }
|
|
|
|
/**
|
|
Returns the object width.
|
|
*/
|
|
wxTextAttrDimension& GetWidth() { return m_size.m_width; }
|
|
const wxTextAttrDimension& GetWidth() const { return m_size.m_width; }
|
|
|
|
/**
|
|
Returns the object height.
|
|
*/
|
|
wxTextAttrDimension& GetHeight() { return m_size.m_height; }
|
|
const wxTextAttrDimension& GetHeight() const { return m_size.m_height; }
|
|
|
|
public:
|
|
|
|
int m_flags;
|
|
|
|
wxTextAttrDimensions m_margins;
|
|
wxTextAttrDimensions m_padding;
|
|
wxTextAttrDimensions m_position;
|
|
|
|
wxTextAttrSize m_size;
|
|
|
|
wxTextAttrBorders m_border;
|
|
wxTextAttrBorders m_outline;
|
|
|
|
wxTextBoxAttrFloatStyle m_floatMode;
|
|
wxTextBoxAttrClearStyle m_clearMode;
|
|
wxTextBoxAttrCollapseMode m_collapseMode;
|
|
wxTextBoxAttrVerticalAlignment m_verticalAlignment;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextAttr
|
|
A class representing enhanced attributes for rich text objects.
|
|
This adds a wxTextBoxAttr member to the basic wxTextAttr class.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAttr, wxTextBoxAttr, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextAttr: public wxTextAttr
|
|
{
|
|
public:
|
|
/**
|
|
Constructor taking a wxTextAttr.
|
|
*/
|
|
wxRichTextAttr(const wxTextAttr& attr) { wxTextAttr::Copy(attr); }
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxRichTextAttr(const wxRichTextAttr& attr): wxTextAttr() { Copy(attr); }
|
|
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxRichTextAttr() {}
|
|
|
|
/**
|
|
Copy function.
|
|
*/
|
|
void Copy(const wxRichTextAttr& attr);
|
|
|
|
/**
|
|
Assignment operator.
|
|
*/
|
|
void operator=(const wxRichTextAttr& attr) { Copy(attr); }
|
|
|
|
/**
|
|
Assignment operator.
|
|
*/
|
|
void operator=(const wxTextAttr& attr) { wxTextAttr::Copy(attr); }
|
|
|
|
/**
|
|
Equality test.
|
|
*/
|
|
bool operator==(const wxRichTextAttr& attr) const;
|
|
|
|
/**
|
|
Partial equality test taking comparison object into account.
|
|
*/
|
|
bool EqPartial(const wxRichTextAttr& attr) const;
|
|
|
|
/**
|
|
Merges the given attributes. If @a compareWith
|
|
is non-NULL, then it will be used to mask out those attributes that are the same in style
|
|
and @a compareWith, for situations where we don't want to explicitly set inherited attributes.
|
|
*/
|
|
bool Apply(const wxRichTextAttr& style, const wxRichTextAttr* compareWith = NULL);
|
|
|
|
/**
|
|
Collects the attributes that are common to a range of content, building up a note of
|
|
which attributes are absent in some objects and which clash in some objects.
|
|
*/
|
|
void CollectCommonAttributes(const wxRichTextAttr& attr, wxRichTextAttr& clashingAttr, wxRichTextAttr& absentAttr);
|
|
|
|
/**
|
|
Removes the specified attributes from this object.
|
|
*/
|
|
bool RemoveStyle(const wxRichTextAttr& attr);
|
|
|
|
/**
|
|
Returns the text box attributes.
|
|
*/
|
|
wxTextBoxAttr& GetTextBoxAttr() { return m_textBoxAttr; }
|
|
const wxTextBoxAttr& GetTextBoxAttr() const { return m_textBoxAttr; }
|
|
|
|
/**
|
|
Set the text box attributes.
|
|
*/
|
|
void SetTextBoxAttr(const wxTextBoxAttr& attr) { m_textBoxAttr = attr; }
|
|
|
|
wxTextBoxAttr m_textBoxAttr;
|
|
};
|
|
|
|
WX_DECLARE_USER_EXPORTED_OBJARRAY(wxVariant, wxRichTextVariantArray, WXDLLIMPEXP_RICHTEXT);
|
|
|
|
/**
|
|
@class wxRichTextProperties
|
|
A simple property class using wxVariants. This is used to give each rich text object the
|
|
ability to store custom properties that can be used by the application.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextObject, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextProperties: public wxObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextProperties)
|
|
public:
|
|
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxRichTextProperties() {}
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxRichTextProperties(const wxRichTextProperties& props): wxObject() { Copy(props); }
|
|
|
|
/**
|
|
Assignment operator.
|
|
*/
|
|
void operator=(const wxRichTextProperties& props) { Copy(props); }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxRichTextProperties& props) const;
|
|
|
|
/**
|
|
Copies from @a props.
|
|
*/
|
|
void Copy(const wxRichTextProperties& props) { m_properties = props.m_properties; }
|
|
|
|
/**
|
|
Returns the variant at the given index.
|
|
*/
|
|
const wxVariant& operator[](size_t idx) const { return m_properties[idx]; }
|
|
|
|
/**
|
|
Returns the variant at the given index.
|
|
*/
|
|
wxVariant& operator[](size_t idx) { return m_properties[idx]; }
|
|
|
|
/**
|
|
Clears the properties.
|
|
*/
|
|
void Clear() { m_properties.Clear(); }
|
|
|
|
/**
|
|
Returns the array of variants implementing the properties.
|
|
*/
|
|
const wxRichTextVariantArray& GetProperties() const { return m_properties; }
|
|
|
|
/**
|
|
Returns the array of variants implementing the properties.
|
|
*/
|
|
wxRichTextVariantArray& GetProperties() { return m_properties; }
|
|
|
|
/**
|
|
Sets the array of variants.
|
|
*/
|
|
void SetProperties(const wxRichTextVariantArray& props) { m_properties = props; }
|
|
|
|
/**
|
|
Returns all the property names.
|
|
*/
|
|
wxArrayString GetPropertyNames() const;
|
|
|
|
/**
|
|
Returns a count of the properties.
|
|
*/
|
|
size_t GetCount() const { return m_properties.GetCount(); }
|
|
|
|
/**
|
|
Returns @true if the given property is found.
|
|
*/
|
|
bool HasProperty(const wxString& name) const { return Find(name) != -1; }
|
|
|
|
/**
|
|
Finds the given property.
|
|
*/
|
|
int Find(const wxString& name) const;
|
|
|
|
/**
|
|
Gets the property variant by name.
|
|
*/
|
|
const wxVariant& GetProperty(const wxString& name) const;
|
|
|
|
/**
|
|
Finds or creates a property with the given name, returning a pointer to the variant.
|
|
*/
|
|
wxVariant* FindOrCreateProperty(const wxString& name);
|
|
|
|
/**
|
|
Gets the value of the named property as a string.
|
|
*/
|
|
wxString GetPropertyString(const wxString& name) const;
|
|
|
|
/**
|
|
Gets the value of the named property as a long integer.
|
|
*/
|
|
long GetPropertyLong(const wxString& name) const;
|
|
|
|
/**
|
|
Gets the value of the named property as a boolean.
|
|
*/
|
|
bool GetPropertyBool(const wxString& name) const;
|
|
|
|
/**
|
|
Gets the value of the named property as a double.
|
|
*/
|
|
double GetPropertyDouble(const wxString& name) const;
|
|
|
|
/**
|
|
Sets the property by passing a variant which contains a name and value.
|
|
*/
|
|
void SetProperty(const wxVariant& variant);
|
|
|
|
/**
|
|
Sets a property by name and variant.
|
|
*/
|
|
void SetProperty(const wxString& name, const wxVariant& variant);
|
|
|
|
/**
|
|
Sets a property by name and string value.
|
|
*/
|
|
void SetProperty(const wxString& name, const wxString& value);
|
|
|
|
/**
|
|
Sets property by name and long integer value.
|
|
*/
|
|
void SetProperty(const wxString& name, long value);
|
|
|
|
/**
|
|
Sets property by name and double value.
|
|
*/
|
|
void SetProperty(const wxString& name, double value);
|
|
|
|
/**
|
|
Sets property by name and boolean value.
|
|
*/
|
|
void SetProperty(const wxString& name, bool value);
|
|
|
|
protected:
|
|
wxRichTextVariantArray m_properties;
|
|
};
|
|
|
|
|
|
/**
|
|
@class wxRichTextFontTable
|
|
Manages quick access to a pool of fonts for rendering rich text.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextFontTable: public wxObject
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxRichTextFontTable();
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxRichTextFontTable(const wxRichTextFontTable& table);
|
|
virtual ~wxRichTextFontTable();
|
|
|
|
/**
|
|
Returns @true if the font table is valid.
|
|
*/
|
|
bool IsOk() const { return m_refData != NULL; }
|
|
|
|
/**
|
|
Finds a font for the given attribute object.
|
|
*/
|
|
wxFont FindFont(const wxRichTextAttr& fontSpec);
|
|
|
|
/**
|
|
Clears the font table.
|
|
*/
|
|
void Clear();
|
|
|
|
/**
|
|
Assignment operator.
|
|
*/
|
|
void operator= (const wxRichTextFontTable& table);
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator == (const wxRichTextFontTable& table) const;
|
|
|
|
/**
|
|
Inequality operator.
|
|
*/
|
|
bool operator != (const wxRichTextFontTable& table) const { return !(*this == table); }
|
|
|
|
protected:
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextFontTable)
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextRange
|
|
|
|
This stores beginning and end positions for a range of data.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextRange
|
|
{
|
|
public:
|
|
// Constructors
|
|
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxRichTextRange() { m_start = 0; m_end = 0; }
|
|
|
|
/**
|
|
Constructor taking start and end positions.
|
|
*/
|
|
wxRichTextRange(long start, long end) { m_start = start; m_end = end; }
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxRichTextRange(const wxRichTextRange& range) { m_start = range.m_start; m_end = range.m_end; }
|
|
~wxRichTextRange() {}
|
|
|
|
/**
|
|
Assigns @a range to this range.
|
|
*/
|
|
void operator =(const wxRichTextRange& range) { m_start = range.m_start; m_end = range.m_end; }
|
|
|
|
/**
|
|
Equality operator. Returns @true if @a range is the same as this range.
|
|
*/
|
|
bool operator ==(const wxRichTextRange& range) const { return (m_start == range.m_start && m_end == range.m_end); }
|
|
|
|
/**
|
|
Inequality operator.
|
|
*/
|
|
bool operator !=(const wxRichTextRange& range) const { return (m_start != range.m_start || m_end != range.m_end); }
|
|
|
|
/**
|
|
Subtracts a range from this range.
|
|
*/
|
|
wxRichTextRange operator -(const wxRichTextRange& range) const { return wxRichTextRange(m_start - range.m_start, m_end - range.m_end); }
|
|
|
|
/**
|
|
Adds a range to this range.
|
|
*/
|
|
wxRichTextRange operator +(const wxRichTextRange& range) const { return wxRichTextRange(m_start + range.m_start, m_end + range.m_end); }
|
|
|
|
/**
|
|
Sets the range start and end positions.
|
|
*/
|
|
void SetRange(long start, long end) { m_start = start; m_end = end; }
|
|
|
|
/**
|
|
Sets the start position.
|
|
*/
|
|
void SetStart(long start) { m_start = start; }
|
|
|
|
/**
|
|
Returns the start position.
|
|
*/
|
|
long GetStart() const { return m_start; }
|
|
|
|
/**
|
|
Sets the end position.
|
|
*/
|
|
void SetEnd(long end) { m_end = end; }
|
|
|
|
/**
|
|
Gets the end position.
|
|
*/
|
|
long GetEnd() const { return m_end; }
|
|
|
|
/**
|
|
Returns true if this range is completely outside @a range.
|
|
*/
|
|
bool IsOutside(const wxRichTextRange& range) const { return range.m_start > m_end || range.m_end < m_start; }
|
|
|
|
/**
|
|
Returns true if this range is completely within @a range.
|
|
*/
|
|
bool IsWithin(const wxRichTextRange& range) const { return m_start >= range.m_start && m_end <= range.m_end; }
|
|
|
|
/**
|
|
Returns true if @a pos was within the range. Does not match if the range is empty.
|
|
*/
|
|
bool Contains(long pos) const { return pos >= m_start && pos <= m_end ; }
|
|
|
|
/**
|
|
Limit this range to be within @a range.
|
|
*/
|
|
bool LimitTo(const wxRichTextRange& range) ;
|
|
|
|
/**
|
|
Gets the length of the range.
|
|
*/
|
|
long GetLength() const { return m_end - m_start + 1; }
|
|
|
|
/**
|
|
Swaps the start and end.
|
|
*/
|
|
void Swap() { long tmp = m_start; m_start = m_end; m_end = tmp; }
|
|
|
|
/**
|
|
Converts the API-standard range, whose end is one past the last character in
|
|
the range, to the internal form, which uses the first and last character
|
|
positions of the range. In other words, one is subtracted from the end position.
|
|
(n, n) is the range of a single character.
|
|
*/
|
|
wxRichTextRange ToInternal() const { return wxRichTextRange(m_start, m_end-1); }
|
|
|
|
/**
|
|
Converts the internal range, which uses the first and last character positions
|
|
of the range, to the API-standard range, whose end is one past the last
|
|
character in the range. In other words, one is added to the end position.
|
|
(n, n+1) is the range of a single character.
|
|
*/
|
|
wxRichTextRange FromInternal() const { return wxRichTextRange(m_start, m_end+1); }
|
|
|
|
protected:
|
|
long m_start;
|
|
long m_end;
|
|
};
|
|
|
|
WX_DECLARE_USER_EXPORTED_OBJARRAY(wxRichTextRange, wxRichTextRangeArray, WXDLLIMPEXP_RICHTEXT);
|
|
|
|
#define wxRICHTEXT_ALL wxRichTextRange(-2, -2)
|
|
#define wxRICHTEXT_NONE wxRichTextRange(-1, -1)
|
|
|
|
#define wxRICHTEXT_NO_SELECTION wxRichTextRange(-2, -2)
|
|
|
|
/**
|
|
@class wxRichTextSelection
|
|
|
|
Stores selection information. The selection does not have to be contiguous, though currently non-contiguous
|
|
selections are only supported for a range of table cells (a geometric block of cells can consist
|
|
of a set of non-contiguous positions).
|
|
|
|
The selection consists of an array of ranges, and the container that is the context for the selection. It
|
|
follows that a single selection object can only represent ranges with the same parent container.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextSelection
|
|
{
|
|
public:
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxRichTextSelection(const wxRichTextSelection& sel) { Copy(sel); }
|
|
|
|
/**
|
|
Creates a selection from a range and a container.
|
|
*/
|
|
wxRichTextSelection(const wxRichTextRange& range, wxRichTextParagraphLayoutBox* container) { m_ranges.Add(range); m_container = container; }
|
|
|
|
/**
|
|
Default constructor.
|
|
*/
|
|
wxRichTextSelection() { Reset(); }
|
|
|
|
/**
|
|
Resets the selection.
|
|
*/
|
|
void Reset() { m_ranges.Clear(); m_container = NULL; }
|
|
|
|
/**
|
|
Sets the selection.
|
|
*/
|
|
|
|
void Set(const wxRichTextRange& range, wxRichTextParagraphLayoutBox* container)
|
|
{ m_ranges.Clear(); m_ranges.Add(range); m_container = container; }
|
|
|
|
/**
|
|
Adds a range to the selection.
|
|
*/
|
|
void Add(const wxRichTextRange& range)
|
|
{ m_ranges.Add(range); }
|
|
|
|
/**
|
|
Sets the selections from an array of ranges and a container object.
|
|
*/
|
|
void Set(const wxRichTextRangeArray& ranges, wxRichTextParagraphLayoutBox* container)
|
|
{ m_ranges = ranges; m_container = container; }
|
|
|
|
/**
|
|
Copies from @a sel.
|
|
*/
|
|
void Copy(const wxRichTextSelection& sel)
|
|
{ m_ranges = sel.m_ranges; m_container = sel.m_container; }
|
|
|
|
/**
|
|
Assignment operator.
|
|
*/
|
|
void operator=(const wxRichTextSelection& sel) { Copy(sel); }
|
|
|
|
/**
|
|
Equality operator.
|
|
*/
|
|
bool operator==(const wxRichTextSelection& sel) const;
|
|
|
|
/**
|
|
Index operator.
|
|
*/
|
|
wxRichTextRange operator[](size_t i) const { return GetRange(i); }
|
|
|
|
/**
|
|
Returns the selection ranges.
|
|
*/
|
|
wxRichTextRangeArray& GetRanges() { return m_ranges; }
|
|
|
|
/**
|
|
Returns the selection ranges.
|
|
*/
|
|
const wxRichTextRangeArray& GetRanges() const { return m_ranges; }
|
|
|
|
/**
|
|
Sets the selection ranges.
|
|
*/
|
|
void SetRanges(const wxRichTextRangeArray& ranges) { m_ranges = ranges; }
|
|
|
|
/**
|
|
Returns the number of ranges in the selection.
|
|
*/
|
|
size_t GetCount() const { return m_ranges.GetCount(); }
|
|
|
|
/**
|
|
Returns the range at the given index.
|
|
|
|
*/
|
|
wxRichTextRange GetRange(size_t i) const { return m_ranges[i]; }
|
|
|
|
/**
|
|
Returns the first range if there is one, otherwise wxRICHTEXT_NO_SELECTION.
|
|
*/
|
|
wxRichTextRange GetRange() const { return (m_ranges.GetCount() > 0) ? (m_ranges[0]) : wxRICHTEXT_NO_SELECTION; }
|
|
|
|
/**
|
|
Sets a single range.
|
|
*/
|
|
void SetRange(const wxRichTextRange& range) { m_ranges.Clear(); m_ranges.Add(range); }
|
|
|
|
/**
|
|
Returns the container for which the selection is valid.
|
|
*/
|
|
wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; }
|
|
|
|
/**
|
|
Sets the container for which the selection is valid.
|
|
*/
|
|
void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; }
|
|
|
|
/**
|
|
Returns @true if the selection is valid.
|
|
*/
|
|
bool IsValid() const { return m_ranges.GetCount() > 0 && GetContainer(); }
|
|
|
|
/**
|
|
Returns the selection appropriate to the specified object, if any; returns an empty array if none
|
|
at the level of the object's container.
|
|
*/
|
|
wxRichTextRangeArray GetSelectionForObject(wxRichTextObject* obj) const;
|
|
|
|
/**
|
|
Returns @true if the given position is within the selection.
|
|
*/
|
|
bool WithinSelection(long pos, wxRichTextObject* obj) const;
|
|
|
|
/**
|
|
Returns @true if the given position is within the selection.
|
|
|
|
*/
|
|
bool WithinSelection(long pos) const { return WithinSelection(pos, m_ranges); }
|
|
|
|
/**
|
|
Returns @true if the given position is within the selection range.
|
|
*/
|
|
static bool WithinSelection(long pos, const wxRichTextRangeArray& ranges);
|
|
|
|
/**
|
|
Returns @true if the given range is within the selection range.
|
|
*/
|
|
static bool WithinSelection(const wxRichTextRange& range, const wxRichTextRangeArray& ranges);
|
|
|
|
wxRichTextRangeArray m_ranges;
|
|
wxRichTextParagraphLayoutBox* m_container;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextObject
|
|
|
|
This is the base for drawable rich text objects.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextObject: public wxObject
|
|
{
|
|
DECLARE_CLASS(wxRichTextObject)
|
|
public:
|
|
/**
|
|
Constructor, taking an optional parent pointer.
|
|
*/
|
|
wxRichTextObject(wxRichTextObject* parent = NULL);
|
|
|
|
virtual ~wxRichTextObject();
|
|
|
|
// Overridables
|
|
|
|
/**
|
|
Draw the item, within the given range. Some objects may ignore the range (for
|
|
example paragraphs) while others must obey it (lines, to implement wrapping)
|
|
*/
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style) = 0;
|
|
|
|
/**
|
|
Lay the item out at the specified position with the given size constraint.
|
|
Layout must set the cached size.
|
|
*/
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style) = 0;
|
|
|
|
/**
|
|
Hit-testing: returns a flag indicating hit test details, plus
|
|
information about position. contextObj is returned to specify what object
|
|
position is relevant to, since otherwise there's an ambiguity.
|
|
obj may not a child of contextObj, since we may be referring to the container itself
|
|
if we have no hit on a child - for example if we click outside an object.
|
|
*/
|
|
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& WXUNUSED(dc), long WXUNUSED(index), wxPoint& WXUNUSED(pt), int* WXUNUSED(height), bool WXUNUSED(forceLineStart)) { return false; }
|
|
|
|
/**
|
|
Returns the best size, i.e. the ideal starting size for this object irrespective
|
|
of available space. For a short text string, it will be the size that exactly encloses
|
|
the text. For a longer string, it might use the parent width for example.
|
|
*/
|
|
virtual wxSize GetBestSize() const { return m_size; }
|
|
|
|
/**
|
|
Returns 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 = 0;
|
|
|
|
/**
|
|
Do a split from @a pos, returning an object containing the second part, and setting
|
|
the first part in 'this'.
|
|
*/
|
|
virtual wxRichTextObject* DoSplit(long WXUNUSED(pos)) { return NULL; }
|
|
|
|
/**
|
|
Calculates the range of the object. By default, guess that the object is 1 unit long.
|
|
*/
|
|
virtual void CalculateRange(long start, long& end) { end = start ; m_range.SetRange(start, end); }
|
|
|
|
/**
|
|
Deletes the given range.
|
|
*/
|
|
virtual bool DeleteRange(const wxRichTextRange& WXUNUSED(range)) { return false; }
|
|
|
|
/**
|
|
Returns @true if the object is empty.
|
|
*/
|
|
virtual bool IsEmpty() const { return false; }
|
|
|
|
/**
|
|
Returns @true if this class of object is floatable.
|
|
*/
|
|
virtual bool IsFloatable() const { return false; }
|
|
|
|
/**
|
|
Returns @true if this object is currently floating.
|
|
*/
|
|
virtual bool IsFloating() const { return GetAttributes().GetTextBoxAttr().IsFloating(); }
|
|
|
|
/**
|
|
Returns the floating direction.
|
|
*/
|
|
virtual int GetFloatDirection() const { return GetAttributes().GetTextBoxAttr().GetFloatMode(); }
|
|
|
|
/**
|
|
Returns any text in this object for the given range.
|
|
*/
|
|
virtual wxString GetTextForRange(const wxRichTextRange& WXUNUSED(range)) const { return wxEmptyString; }
|
|
|
|
/**
|
|
Returns @true if this object can merge itself with the given one.
|
|
*/
|
|
virtual bool CanMerge(wxRichTextObject* WXUNUSED(object)) const { return false; }
|
|
|
|
/**
|
|
Returns @true if this object merged itself with the given one.
|
|
The calling code will then delete the given object.
|
|
*/
|
|
virtual bool Merge(wxRichTextObject* WXUNUSED(object)) { return false; }
|
|
|
|
/**
|
|
Dump object data to the given output stream for debugging.
|
|
*/
|
|
virtual void Dump(wxTextOutputStream& stream);
|
|
|
|
/**
|
|
Returns @true if we can edit the object's properties via a GUI.
|
|
*/
|
|
virtual bool CanEditProperties() const { return false; }
|
|
|
|
/**
|
|
Edits the object's properties via a GUI.
|
|
*/
|
|
virtual bool EditProperties(wxWindow* WXUNUSED(parent), wxRichTextBuffer* WXUNUSED(buffer)) { return false; }
|
|
|
|
/**
|
|
Returns the label to be used for the properties context menu item.
|
|
*/
|
|
virtual wxString GetPropertiesMenuLabel() const { return wxEmptyString; }
|
|
|
|
/**
|
|
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; }
|
|
|
|
#if wxUSE_XML
|
|
/**
|
|
Imports this object from XML.
|
|
*/
|
|
virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
|
|
/**
|
|
Exports this object directly to the given stream, bypassing the creation of a wxXmlNode hierarchy.
|
|
This method is considerably faster than creating a tree first. However, both versions of ExportXML must be
|
|
implemented so that if the tree method is made efficient in the future, we can deprecate the
|
|
more verbose direct output method. Compiled only if wxRICHTEXT_HAVE_DIRECT_OUTPUT is defined (on by default).
|
|
*/
|
|
virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
|
|
/**
|
|
Exports this object to the given parent node, usually creating at least one child node.
|
|
This method is less efficient than the direct-to-stream method but is retained to allow for
|
|
switching to this method if we make it more efficient. Compiled only if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT is defined
|
|
(on by default).
|
|
*/
|
|
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
/**
|
|
Returns @true if this object takes note of paragraph attributes (text and image objects don't).
|
|
*/
|
|
virtual bool UsesParagraphAttributes() const { return true; }
|
|
|
|
/**
|
|
Returns the XML node name of this object. This must be overridden for wxXmlNode-base XML export to work.
|
|
*/
|
|
virtual wxString GetXMLNodeName() const { return wxT("unknown"); }
|
|
|
|
/**
|
|
Invalidates the object at the given range. With no argument, invalidates the whole object.
|
|
*/
|
|
virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL);
|
|
|
|
/**
|
|
Returns @true if this object can handle the selections of its children, fOr example a table.
|
|
Required for composite selection handling to work.
|
|
*/
|
|
virtual bool HandlesChildSelections() const { return false; }
|
|
|
|
/**
|
|
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 WXUNUSED(start), long WXUNUSED(end)) const { return wxRichTextSelection(); }
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
Gets the cached object size as calculated by Layout.
|
|
*/
|
|
virtual wxSize GetCachedSize() const { return m_size; }
|
|
|
|
/**
|
|
Sets the cached object size as calculated by Layout.
|
|
*/
|
|
virtual void SetCachedSize(const wxSize& sz) { m_size = sz; }
|
|
|
|
/**
|
|
Gets the maximum object size as calculated by Layout. This allows
|
|
us to fit an object to its contents or allocate extra space if required.
|
|
*/
|
|
virtual wxSize GetMaxSize() const { return m_maxSize; }
|
|
|
|
/**
|
|
Sets the maximum object size as calculated by Layout. This allows
|
|
us to fit an object to its contents or allocate extra space if required.
|
|
*/
|
|
virtual void SetMaxSize(const wxSize& sz) { m_maxSize = sz; }
|
|
|
|
/**
|
|
Gets the minimum object size as calculated by Layout. This allows
|
|
us to constrain an object to its absolute minimum size if necessary.
|
|
*/
|
|
virtual wxSize GetMinSize() const { return m_minSize; }
|
|
|
|
/**
|
|
Sets the minimum object size as calculated by Layout. This allows
|
|
us to constrain an object to its absolute minimum size if necessary.
|
|
*/
|
|
virtual void SetMinSize(const wxSize& sz) { m_minSize = sz; }
|
|
|
|
/**
|
|
Gets the 'natural' size for an object. For an image, it would be the
|
|
image size.
|
|
*/
|
|
virtual wxTextAttrSize GetNaturalSize() const { return wxTextAttrSize(); }
|
|
|
|
/**
|
|
Returns the object position in pixels.
|
|
*/
|
|
virtual wxPoint GetPosition() const { return m_pos; }
|
|
|
|
/**
|
|
Sets the object position in pixels.
|
|
*/
|
|
virtual void SetPosition(const wxPoint& pos) { m_pos = pos; }
|
|
|
|
/**
|
|
Returns the absolute object position, by traversing up the child/parent hierarchy.
|
|
TODO: may not be needed, if all object positions are in fact relative to the
|
|
top of the coordinate space.
|
|
*/
|
|
virtual wxPoint GetAbsolutePosition() const;
|
|
|
|
/**
|
|
Returns the rectangle enclosing the object.
|
|
*/
|
|
virtual wxRect GetRect() const { return wxRect(GetPosition(), GetCachedSize()); }
|
|
|
|
/**
|
|
Sets the object's range within its container.
|
|
*/
|
|
void SetRange(const wxRichTextRange& range) { m_range = range; }
|
|
|
|
/**
|
|
Returns the object's range.
|
|
*/
|
|
const wxRichTextRange& GetRange() const { return m_range; }
|
|
|
|
/**
|
|
Returns the object's range.
|
|
*/
|
|
wxRichTextRange& GetRange() { return m_range; }
|
|
|
|
/**
|
|
Set the object's own range, for a top-level object with its own position space.
|
|
*/
|
|
void SetOwnRange(const wxRichTextRange& range) { m_ownRange = range; }
|
|
|
|
/**
|
|
Returns the object's own range (valid if top-level).
|
|
*/
|
|
const wxRichTextRange& GetOwnRange() const { return m_ownRange; }
|
|
|
|
/**
|
|
Returns the object's own range (valid if top-level).
|
|
*/
|
|
wxRichTextRange& GetOwnRange() { return m_ownRange; }
|
|
|
|
/**
|
|
Returns the object's own range only if a top-level object.
|
|
*/
|
|
wxRichTextRange GetOwnRangeIfTopLevel() const { return IsTopLevel() ? m_ownRange : m_range; }
|
|
|
|
/**
|
|
Returns @true if this object this composite.
|
|
*/
|
|
virtual bool IsComposite() const { return false; }
|
|
|
|
/**
|
|
Returns a pointer to the parent object.
|
|
*/
|
|
virtual wxRichTextObject* GetParent() const { return m_parent; }
|
|
|
|
/**
|
|
Sets the pointer to the parent object.
|
|
*/
|
|
virtual void SetParent(wxRichTextObject* parent) { m_parent = parent; }
|
|
|
|
/**
|
|
Returns the top-level container of this object.
|
|
May return itself if it's a container; use GetParentContainer to return
|
|
a different container.
|
|
*/
|
|
virtual wxRichTextParagraphLayoutBox* GetContainer() const;
|
|
|
|
/**
|
|
Returns the top-level container of this object.
|
|
Returns a different container than itself, unless there's no parent, in which case it will return NULL.
|
|
*/
|
|
virtual wxRichTextParagraphLayoutBox* GetParentContainer() const { return GetParent() ? GetParent()->GetContainer() : GetContainer(); }
|
|
|
|
/**
|
|
Set the margin around the object, in pixels.
|
|
*/
|
|
virtual void SetMargins(int margin);
|
|
|
|
/**
|
|
Set the margin around the object, in pixels.
|
|
*/
|
|
virtual void SetMargins(int leftMargin, int rightMargin, int topMargin, int bottomMargin);
|
|
|
|
/**
|
|
Returns the left margin of the object, in pixels.
|
|
*/
|
|
virtual int GetLeftMargin() const;
|
|
|
|
/**
|
|
Returns the right margin of the object, in pixels.
|
|
*/
|
|
virtual int GetRightMargin() const;
|
|
|
|
/**
|
|
Returns the top margin of the object, in pixels.
|
|
*/
|
|
virtual int GetTopMargin() const;
|
|
|
|
/**
|
|
Returns the bottom margin of the object, in pixels.
|
|
*/
|
|
virtual int GetBottomMargin() const;
|
|
|
|
/**
|
|
Calculates the available content space in the given rectangle, given the
|
|
margins, border and padding specified in the object's attributes.
|
|
*/
|
|
virtual wxRect GetAvailableContentArea(wxDC& dc, const wxRect& outerRect) const;
|
|
|
|
/**
|
|
Lays out the object first with a given amount of space, and then if no width was specified in attr,
|
|
lays out the object again using the minimum size
|
|
*/
|
|
virtual bool LayoutToBestSize(wxDC& dc, wxRichTextBuffer* buffer,
|
|
const wxRichTextAttr& parentAttr, const wxRichTextAttr& attr, const wxRect& availableParentSpace, int style);
|
|
|
|
/**
|
|
Sets the object's attributes.
|
|
*/
|
|
void SetAttributes(const wxRichTextAttr& attr) { m_attributes = attr; }
|
|
|
|
/**
|
|
Returns the object's attributes.
|
|
*/
|
|
const wxRichTextAttr& GetAttributes() const { return m_attributes; }
|
|
|
|
/**
|
|
Returns the object's attributes.
|
|
*/
|
|
wxRichTextAttr& GetAttributes() { return m_attributes; }
|
|
|
|
/**
|
|
Sets the object's properties.
|
|
*/
|
|
wxRichTextProperties& GetProperties() { return m_properties; }
|
|
|
|
/**
|
|
Returns the object's properties.
|
|
*/
|
|
const wxRichTextProperties& GetProperties() const { return m_properties; }
|
|
|
|
/**
|
|
Returns the object's properties.
|
|
*/
|
|
void SetProperties(const wxRichTextProperties& props) { m_properties = props; }
|
|
|
|
/**
|
|
Sets the stored descent value.
|
|
*/
|
|
void SetDescent(int descent) { m_descent = descent; }
|
|
|
|
/**
|
|
Returns the stored descent value.
|
|
*/
|
|
int GetDescent() const { return m_descent; }
|
|
|
|
/**
|
|
Returns the containing buffer.
|
|
*/
|
|
wxRichTextBuffer* GetBuffer() const;
|
|
|
|
/**
|
|
Sets the identifying name for this object as a property using the "name" key.
|
|
*/
|
|
void SetName(const wxString& name) { m_properties.SetProperty(wxT("name"), name); }
|
|
|
|
/**
|
|
Returns the identifying name for this object from the properties, using the "name" key.
|
|
*/
|
|
wxString GetName() const { return m_properties.GetPropertyString(wxT("name")); }
|
|
|
|
/**
|
|
Returns @true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
|
|
*/
|
|
virtual bool IsTopLevel() const { return false; }
|
|
|
|
/**
|
|
Returns @true if the object will be shown, @false otherwise.
|
|
*/
|
|
bool IsShown() const { return m_show; }
|
|
|
|
// Operations
|
|
|
|
/**
|
|
Call to show or hide this object. This function does not cause the content to be
|
|
laid out or redrawn.
|
|
*/
|
|
virtual void Show(bool show) { m_show = show; }
|
|
|
|
/**
|
|
Clones the object.
|
|
*/
|
|
virtual wxRichTextObject* Clone() const { return NULL; }
|
|
|
|
/**
|
|
Copies the object.
|
|
*/
|
|
void Copy(const wxRichTextObject& obj);
|
|
|
|
/**
|
|
Reference-counting allows us to use the same object in multiple
|
|
lists (not yet used).
|
|
*/
|
|
|
|
void Reference() { m_refCount ++; }
|
|
|
|
/**
|
|
Reference-counting allows us to use the same object in multiple
|
|
lists (not yet used).
|
|
*/
|
|
void Dereference();
|
|
|
|
/**
|
|
Moves the object recursively, by adding the offset from old to new.
|
|
*/
|
|
virtual void Move(const wxPoint& pt);
|
|
|
|
/**
|
|
Converts units in tenths of a millimetre to device units.
|
|
*/
|
|
int ConvertTenthsMMToPixels(wxDC& dc, int units) const;
|
|
|
|
/**
|
|
Converts units in tenths of a millimetre to device units.
|
|
*/
|
|
static int ConvertTenthsMMToPixels(int ppi, int units, double scale = 1.0);
|
|
|
|
/**
|
|
Convert units in pixels to tenths of a millimetre.
|
|
*/
|
|
int ConvertPixelsToTenthsMM(wxDC& dc, int pixels) const;
|
|
|
|
/**
|
|
Convert units in pixels to tenths of a millimetre.
|
|
*/
|
|
static int ConvertPixelsToTenthsMM(int ppi, int pixels, double scale = 1.0);
|
|
|
|
/**
|
|
Draws the borders and background for the given rectangle and attributes.
|
|
@a boxRect is taken to be the outer margin box, not the box around the content.
|
|
*/
|
|
static bool DrawBoxAttributes(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, const wxRect& boxRect, int flags = 0);
|
|
|
|
/**
|
|
Draws a border.
|
|
*/
|
|
static bool DrawBorder(wxDC& dc, wxRichTextBuffer* buffer, const wxTextAttrBorders& attr, const wxRect& rect, int flags = 0);
|
|
|
|
/**
|
|
Returns the various rectangles of the box model in pixels. You can either specify @a contentRect (inner)
|
|
or @a marginRect (outer), and the other must be the default rectangle (no width or height).
|
|
Note that the outline doesn't affect the position of the rectangle, it's drawn in whatever space
|
|
is available.
|
|
*/
|
|
static bool GetBoxRects(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, wxRect& marginRect, wxRect& borderRect, wxRect& contentRect, wxRect& paddingRect, wxRect& outlineRect);
|
|
|
|
/**
|
|
Returns the total margin for the object in pixels, taking into account margin, padding and border size.
|
|
*/
|
|
static bool GetTotalMargin(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& attr, int& leftMargin, int& rightMargin,
|
|
int& topMargin, int& bottomMargin);
|
|
|
|
/**
|
|
Returns the rectangle which the child has available to it given restrictions specified in the
|
|
child attribute, e.g. 50% width of the parent, 400 pixels, x position 20% of the parent, etc.
|
|
*/
|
|
static wxRect AdjustAvailableSpace(wxDC& dc, wxRichTextBuffer* buffer, const wxRichTextAttr& parentAttr, const wxRichTextAttr& childAttr, const wxRect& availableParentSpace);
|
|
|
|
protected:
|
|
wxSize m_size;
|
|
wxSize m_maxSize;
|
|
wxSize m_minSize;
|
|
wxPoint m_pos;
|
|
int m_descent; // Descent for this object (if any)
|
|
int m_refCount;
|
|
bool m_show;
|
|
wxRichTextObject* m_parent;
|
|
|
|
// The range of this object (start position to end position)
|
|
wxRichTextRange m_range;
|
|
|
|
// The internal range of this object, if it's a top-level object with its own range space
|
|
wxRichTextRange m_ownRange;
|
|
|
|
// Attributes
|
|
wxRichTextAttr m_attributes;
|
|
|
|
// Properties
|
|
wxRichTextProperties m_properties;
|
|
};
|
|
|
|
WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT );
|
|
|
|
/**
|
|
@class wxRichTextCompositeObject
|
|
|
|
Objects of this class can contain other objects.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextObject, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextCompositeObject: public wxRichTextObject
|
|
{
|
|
DECLARE_CLASS(wxRichTextCompositeObject)
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextCompositeObject(wxRichTextObject* parent = NULL);
|
|
virtual ~wxRichTextCompositeObject();
|
|
|
|
// Overridables
|
|
|
|
virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
|
|
|
|
virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
|
|
|
|
virtual void CalculateRange(long start, long& end);
|
|
|
|
virtual bool DeleteRange(const wxRichTextRange& range);
|
|
|
|
virtual wxString GetTextForRange(const wxRichTextRange& range) const;
|
|
|
|
virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
|
|
|
|
virtual void Dump(wxTextOutputStream& stream);
|
|
|
|
virtual void Invalidate(const wxRichTextRange& invalidRange = wxRICHTEXT_ALL);
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
Returns the children.
|
|
*/
|
|
wxRichTextObjectList& GetChildren() { return m_children; }
|
|
/**
|
|
Returns the children.
|
|
*/
|
|
const wxRichTextObjectList& GetChildren() const { return m_children; }
|
|
|
|
/**
|
|
Returns the number of children.
|
|
*/
|
|
size_t GetChildCount() const ;
|
|
|
|
/**
|
|
Returns the nth child.
|
|
*/
|
|
wxRichTextObject* GetChild(size_t n) const ;
|
|
|
|
/**
|
|
Returns @true if this object is composite.
|
|
*/
|
|
virtual bool IsComposite() const { return true; }
|
|
|
|
/**
|
|
Returns true if the buffer is empty.
|
|
*/
|
|
virtual bool IsEmpty() const { return GetChildCount() == 0; }
|
|
|
|
/**
|
|
Returns the child object at the given character position.
|
|
*/
|
|
virtual wxRichTextObject* GetChildAtPosition(long pos) const;
|
|
|
|
// Operations
|
|
|
|
void Copy(const wxRichTextCompositeObject& obj);
|
|
|
|
void operator= (const wxRichTextCompositeObject& obj) { Copy(obj); }
|
|
|
|
/**
|
|
Appends a child, returning the position.
|
|
*/
|
|
size_t AppendChild(wxRichTextObject* child) ;
|
|
|
|
/**
|
|
Inserts the child in front of the given object, or at the beginning.
|
|
*/
|
|
bool InsertChild(wxRichTextObject* child, wxRichTextObject* inFrontOf) ;
|
|
|
|
/**
|
|
Removes and optionally deletes the specified child.
|
|
*/
|
|
bool RemoveChild(wxRichTextObject* child, bool deleteChild = false) ;
|
|
|
|
/**
|
|
Deletes all the children.
|
|
*/
|
|
bool DeleteChildren() ;
|
|
|
|
/**
|
|
Recursively merges all pieces that can be merged.
|
|
*/
|
|
bool Defragment(const wxRichTextRange& range = wxRICHTEXT_ALL);
|
|
|
|
/**
|
|
Moves the object recursively, by adding the offset from old to new.
|
|
*/
|
|
virtual void Move(const wxPoint& pt);
|
|
|
|
protected:
|
|
wxRichTextObjectList m_children;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextParagraphBox
|
|
|
|
This class knows how to lay out paragraphs.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextCompositeObject, wxRichTextObject, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextParagraphLayoutBox: public wxRichTextCompositeObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextParagraphLayoutBox)
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextParagraphLayoutBox(wxRichTextObject* parent = NULL);
|
|
wxRichTextParagraphLayoutBox(const wxRichTextParagraphLayoutBox& obj): wxRichTextCompositeObject() { Init(); Copy(obj); }
|
|
~wxRichTextParagraphLayoutBox();
|
|
|
|
// Overridables
|
|
|
|
virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
|
|
|
|
virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
|
|
|
|
virtual bool DeleteRange(const wxRichTextRange& range);
|
|
|
|
virtual wxString GetTextForRange(const wxRichTextRange& range) const;
|
|
|
|
#if wxUSE_XML
|
|
virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
|
|
virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
|
|
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("paragraphlayout"); }
|
|
|
|
virtual bool AcceptsFocus() const { return true; }
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
Associates a control with the buffer, for operations that for example require refreshing the window.
|
|
*/
|
|
void SetRichTextCtrl(wxRichTextCtrl* ctrl) { m_ctrl = ctrl; }
|
|
|
|
/**
|
|
Returns the associated control.
|
|
*/
|
|
wxRichTextCtrl* GetRichTextCtrl() const { return m_ctrl; }
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
virtual wxRichTextStyleSheet* GetStyleSheet() const;
|
|
|
|
virtual bool IsTopLevel() const { return true; }
|
|
|
|
// Operations
|
|
|
|
/**
|
|
Submits a command to insert paragraphs.
|
|
*/
|
|
bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
|
|
|
|
/**
|
|
Submits a command to insert the given text.
|
|
*/
|
|
bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
|
|
|
|
/**
|
|
Submits a command to insert the given text.
|
|
*/
|
|
bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
|
|
|
|
/**
|
|
Submits a command to insert the given image.
|
|
*/
|
|
bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock,
|
|
wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags,
|
|
const wxRichTextAttr& textAttr);
|
|
|
|
/**
|
|
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;
|
|
|
|
/**
|
|
Inserts an object.
|
|
*/
|
|
wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, wxRichTextBuffer* buffer, int flags = 0);
|
|
|
|
/**
|
|
Submits a command to delete this range.
|
|
*/
|
|
bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl, wxRichTextBuffer* 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);
|
|
|
|
/**
|
|
Moves an anchored object to another paragraph.
|
|
*/
|
|
void MoveAnchoredObjectToParagraph(wxRichTextParagraph* from, wxRichTextParagraph* to, wxRichTextObject* obj);
|
|
|
|
/**
|
|
Initializes the object.
|
|
*/
|
|
void Init();
|
|
|
|
/**
|
|
Clears all the children.
|
|
*/
|
|
virtual void Clear();
|
|
|
|
/**
|
|
Clears and initializes with one blank paragraph.
|
|
*/
|
|
virtual void Reset();
|
|
|
|
/**
|
|
Convenience function to add a paragraph of text.
|
|
*/
|
|
virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL);
|
|
|
|
/**
|
|
Convenience function to add an image.
|
|
*/
|
|
virtual wxRichTextRange AddImage(const wxImage& image, wxRichTextAttr* paraStyle = NULL);
|
|
|
|
/**
|
|
Adds multiple paragraphs, based on newlines.
|
|
*/
|
|
virtual wxRichTextRange AddParagraphs(const wxString& text, wxRichTextAttr* paraStyle = NULL);
|
|
|
|
/**
|
|
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;
|
|
|
|
/**
|
|
Returns the line at the given y pixel position, or the last line.
|
|
*/
|
|
virtual wxRichTextLine* GetLineAtYPosition(int y) const;
|
|
|
|
/**
|
|
Returns the paragraph at the given character or caret position.
|
|
*/
|
|
virtual wxRichTextParagraph* GetParagraphAtPosition(long pos, bool caretPosition = false) const;
|
|
|
|
/**
|
|
Returns the line size at the given position.
|
|
*/
|
|
virtual wxSize GetLineSizeAtPosition(long pos, bool caretPosition = false) const;
|
|
|
|
/**
|
|
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, returns the corresponding wxRichTextLine object.
|
|
*/
|
|
virtual wxRichTextLine* GetLineForVisibleLineNumber(long lineNumber) const;
|
|
|
|
/**
|
|
Returns the leaf object in a paragraph at this position.
|
|
*/
|
|
virtual wxRichTextObject* GetLeafObjectAtPosition(long position) const;
|
|
|
|
/**
|
|
Returns the paragraph by number.
|
|
*/
|
|
virtual wxRichTextParagraph* GetParagraphAtLine(long paragraphNumber) const;
|
|
|
|
/**
|
|
Returns the paragraph for a given line.
|
|
*/
|
|
virtual wxRichTextParagraph* GetParagraphForLine(wxRichTextLine* line) const;
|
|
|
|
/**
|
|
Returns the length of the paragraph.
|
|
*/
|
|
virtual int GetParagraphLength(long paragraphNumber) const;
|
|
|
|
/**
|
|
Returns the number of paragraphs.
|
|
*/
|
|
virtual int GetParagraphCount() const { return static_cast<int>(GetChildCount()); }
|
|
|
|
/**
|
|
Returns the number of visible lines.
|
|
*/
|
|
virtual int GetLineCount() const;
|
|
|
|
/**
|
|
Returns the text of the paragraph.
|
|
*/
|
|
virtual wxString GetParagraphText(long paragraphNumber) const;
|
|
|
|
/**
|
|
Converts zero-based line column and paragraph number to a position.
|
|
*/
|
|
virtual long XYToPosition(long x, long y) const;
|
|
|
|
/**
|
|
Converts a zero-based position to line column and paragraph number.
|
|
*/
|
|
virtual bool PositionToXY(long pos, long* x, long* y) const;
|
|
|
|
/**
|
|
Sets text attributes: character and/or paragraph styles.
|
|
*/
|
|
virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
Returns the combined text attributes for this position.
|
|
*/
|
|
virtual bool GetStyle(long position, wxRichTextAttr& style);
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
virtual bool DoGetStyle(long position, wxRichTextAttr& style, bool combineStyles = true);
|
|
|
|
/**
|
|
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 @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 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 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.
|
|
@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);
|
|
|
|
/**
|
|
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
|
|
@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.
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const;
|
|
|
|
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.
|
|
*/
|
|
virtual bool InsertFragment(long position, wxRichTextParagraphLayoutBox& 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.
|
|
*/
|
|
virtual bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet);
|
|
|
|
void Copy(const wxRichTextParagraphLayoutBox& obj);
|
|
|
|
void operator= (const wxRichTextParagraphLayoutBox& obj) { Copy(obj); }
|
|
|
|
/**
|
|
Calculate ranges.
|
|
*/
|
|
virtual void UpdateRanges();
|
|
|
|
/**
|
|
Get all the text.
|
|
*/
|
|
virtual wxString GetText() const;
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
Returns the default style.
|
|
*/
|
|
virtual const wxRichTextAttr& GetDefaultStyle() const { return m_defaultAttributes; }
|
|
|
|
/**
|
|
Sets the basic (overall) style.
|
|
*/
|
|
virtual void SetBasicStyle(const wxRichTextAttr& style) { m_attributes = style; }
|
|
|
|
/**
|
|
Returns the basic (overall) style.
|
|
*/
|
|
virtual const wxRichTextAttr& GetBasicStyle() const { return m_attributes; }
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
virtual void DoInvalidate(const wxRichTextRange& invalidRange);
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
virtual bool UpdateFloatingObjects(const wxRect& availableRect, wxRichTextObject* untilObj = NULL);
|
|
|
|
/**
|
|
Get invalid range, rounding to entire paragraphs if argument is true.
|
|
*/
|
|
wxRichTextRange GetInvalidRange(bool wholeParagraphs = false) const;
|
|
|
|
/**
|
|
Returns @true if this object needs layout.
|
|
*/
|
|
bool IsDirty() const { return m_invalidRange != wxRICHTEXT_NONE; }
|
|
|
|
/**
|
|
Returns the wxRichTextFloatCollector of this object.
|
|
*/
|
|
wxRichTextFloatCollector* GetFloatCollector() { return m_floatCollector; }
|
|
|
|
/**
|
|
Returns the number of floating objects at this level.
|
|
*/
|
|
int GetFloatingObjectCount() const;
|
|
|
|
/**
|
|
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
|
|
wxRichTextRange m_invalidRange;
|
|
|
|
// Is the last paragraph partial or complete?
|
|
bool m_partialParagraph;
|
|
|
|
// The floating layout state
|
|
wxRichTextFloatCollector* m_floatCollector;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextBox
|
|
|
|
This class implements a floating or inline text box, containing paragraphs.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextParagraphLayoutBox, wxRichTextObject, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextBox: public wxRichTextParagraphLayoutBox
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextBox)
|
|
public:
|
|
// Constructors
|
|
|
|
/**
|
|
Default constructor; optionally pass the parent object.
|
|
*/
|
|
|
|
wxRichTextBox(wxRichTextObject* parent = NULL);
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
|
|
wxRichTextBox(const wxRichTextBox& obj): wxRichTextParagraphLayoutBox() { Copy(obj); }
|
|
|
|
// Overridables
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("textbox"); }
|
|
|
|
virtual bool CanEditProperties() const { return true; }
|
|
|
|
virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer);
|
|
|
|
virtual wxString GetPropertiesMenuLabel() const { return _("&Box"); }
|
|
|
|
// Accessors
|
|
|
|
// Operations
|
|
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextBox(*this); }
|
|
|
|
void Copy(const wxRichTextBox& obj);
|
|
|
|
protected:
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextLine
|
|
|
|
This object represents a line in a paragraph, and stores
|
|
offsets from the start of the paragraph representing the
|
|
start and end positions of the line.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextLine
|
|
{
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextLine(wxRichTextParagraph* parent);
|
|
wxRichTextLine(const wxRichTextLine& obj) { Init( NULL); Copy(obj); }
|
|
virtual ~wxRichTextLine() {}
|
|
|
|
// Overridables
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
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); }
|
|
|
|
/**
|
|
Returns the parent paragraph.
|
|
*/
|
|
wxRichTextParagraph* GetParent() { return m_parent; }
|
|
|
|
/**
|
|
Returns the range.
|
|
*/
|
|
const wxRichTextRange& GetRange() const { return m_range; }
|
|
/**
|
|
Returns the range.
|
|
*/
|
|
wxRichTextRange& GetRange() { return m_range; }
|
|
|
|
/**
|
|
Returns the absolute range.
|
|
*/
|
|
wxRichTextRange GetAbsoluteRange() const;
|
|
|
|
/**
|
|
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; }
|
|
|
|
/**
|
|
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; }
|
|
|
|
/**
|
|
Returns the absolute object position.
|
|
*/
|
|
virtual wxPoint GetAbsolutePosition() const;
|
|
|
|
/**
|
|
Returns the rectangle enclosing the line.
|
|
*/
|
|
virtual wxRect GetRect() const { return wxRect(GetAbsolutePosition(), GetSize()); }
|
|
|
|
/**
|
|
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
|
|
wxArrayInt& GetObjectSizes() { return m_objectSizes; }
|
|
const wxArrayInt& GetObjectSizes() const { return m_objectSizes; }
|
|
#endif
|
|
|
|
// Operations
|
|
|
|
/**
|
|
Initialises the object.
|
|
*/
|
|
void Init(wxRichTextParagraph* parent);
|
|
|
|
/**
|
|
Copies from @a obj.
|
|
*/
|
|
void Copy(const wxRichTextLine& obj);
|
|
|
|
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.
|
|
wxRichTextRange m_range;
|
|
|
|
// Size and position measured relative to top of paragraph
|
|
wxPoint m_pos;
|
|
wxSize m_size;
|
|
|
|
// Maximum descent for this line (location of text baseline)
|
|
int m_descent;
|
|
|
|
// The parent object
|
|
wxRichTextParagraph* m_parent;
|
|
|
|
#if wxRICHTEXT_USE_OPTIMIZED_LINE_DRAWING
|
|
wxArrayInt m_objectSizes;
|
|
#endif
|
|
};
|
|
|
|
WX_DECLARE_LIST_WITH_DECL( wxRichTextLine, wxRichTextLineList , class WXDLLIMPEXP_RICHTEXT );
|
|
|
|
/**
|
|
@class wxRichTextParagraph
|
|
|
|
This object represents a single paragraph containing various objects such as text content, images, and further paragraph layout objects.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph: public wxRichTextCompositeObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextParagraph)
|
|
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
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
|
|
|
|
virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
|
|
|
|
virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
|
|
|
|
virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
|
|
|
|
virtual void CalculateRange(long start, long& end);
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("paragraph"); }
|
|
|
|
// Accessors
|
|
|
|
/**
|
|
Returns the cached lines.
|
|
*/
|
|
wxRichTextLineList& GetLines() { return m_cachedLines; }
|
|
|
|
// Operations
|
|
|
|
/**
|
|
Copies the object.
|
|
*/
|
|
void Copy(const wxRichTextParagraph& obj);
|
|
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextParagraph(*this); }
|
|
|
|
/**
|
|
Clears the cached lines.
|
|
*/
|
|
void ClearLines();
|
|
|
|
// Implementation
|
|
|
|
/**
|
|
Applies paragraph styles such as centering to the wrapped lines.
|
|
*/
|
|
virtual void ApplyParagraphStyle(wxRichTextLine* line, const wxRichTextAttr& attr, const wxRect& rect, wxDC& dc);
|
|
|
|
/**
|
|
Inserts text at the given position.
|
|
*/
|
|
virtual bool InsertText(long pos, const wxString& text);
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
Moves content to a list from this point.
|
|
*/
|
|
virtual void MoveToList(wxRichTextObject* obj, wxList& list);
|
|
|
|
/**
|
|
Adds content back from a list.
|
|
*/
|
|
virtual void MoveFromList(wxList& list);
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
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);
|
|
|
|
/**
|
|
Finds the object at the given position.
|
|
*/
|
|
wxRichTextObject* FindObjectAtPosition(long position);
|
|
|
|
/**
|
|
Returns the bullet text for this paragraph.
|
|
*/
|
|
wxString GetBulletText();
|
|
|
|
/**
|
|
Allocates or reuses a line object.
|
|
*/
|
|
wxRichTextLine* AllocateLine(int pos);
|
|
|
|
/**
|
|
Clears remaining unused line objects, if any.
|
|
*/
|
|
bool ClearUnusedLines(int lineCount);
|
|
|
|
/**
|
|
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;
|
|
|
|
/**
|
|
Returns the combined attributes of the base style and paragraph style.
|
|
*/
|
|
wxRichTextAttr GetCombinedAttributes(bool includingBoxAttr = false) const;
|
|
|
|
/**
|
|
Returns the first position from pos that has a line break character.
|
|
*/
|
|
long GetFirstLineBreakPosition(long pos);
|
|
|
|
/**
|
|
Creates a default tabstop array.
|
|
*/
|
|
static void InitDefaultTabs();
|
|
|
|
/**
|
|
Clears the default tabstop array.
|
|
*/
|
|
static void ClearDefaultTabs();
|
|
|
|
/**
|
|
Returns the default tabstop array.
|
|
*/
|
|
static const wxArrayInt& GetDefaultTabs() { return sm_defaultTabs; }
|
|
|
|
/**
|
|
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
|
|
wxRichTextLineList m_cachedLines;
|
|
|
|
// Default tabstops
|
|
static wxArrayInt sm_defaultTabs;
|
|
|
|
friend class wxRichTextFloatCollector;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextPlainText
|
|
|
|
This object represents a single piece of text.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextPlainText: public wxRichTextObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextPlainText)
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextPlainText(const wxString& text = wxEmptyString, wxRichTextObject* parent = NULL, wxRichTextAttr* style = NULL);
|
|
wxRichTextPlainText(const wxRichTextPlainText& obj): wxRichTextObject() { Copy(obj); }
|
|
|
|
// Overridables
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
|
|
|
|
virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
|
|
|
|
virtual wxString GetTextForRange(const wxRichTextRange& range) const;
|
|
|
|
virtual wxRichTextObject* DoSplit(long pos);
|
|
|
|
virtual void CalculateRange(long start, long& end);
|
|
|
|
virtual bool DeleteRange(const wxRichTextRange& range);
|
|
|
|
virtual bool IsEmpty() const { return m_text.empty(); }
|
|
|
|
virtual bool CanMerge(wxRichTextObject* object) const;
|
|
|
|
virtual bool Merge(wxRichTextObject* object);
|
|
|
|
virtual void Dump(wxTextOutputStream& stream);
|
|
|
|
/// Get the first position from pos that has a line break character.
|
|
long GetFirstLineBreakPosition(long pos);
|
|
|
|
/// Does this object take note of paragraph attributes? Text and image objects don't.
|
|
virtual bool UsesParagraphAttributes() const { return false; }
|
|
|
|
#if wxUSE_XML
|
|
virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
|
|
virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
|
|
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("text"); }
|
|
|
|
// Accessors
|
|
|
|
/// Get the text
|
|
const wxString& GetText() const { return m_text; }
|
|
|
|
/// Set the text
|
|
void SetText(const wxString& text) { m_text = text; }
|
|
|
|
// Operations
|
|
|
|
/// Copy
|
|
void Copy(const wxRichTextPlainText& obj);
|
|
|
|
/// Clone
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextPlainText(*this); }
|
|
private:
|
|
bool DrawTabbedString(wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, wxString& str, wxCoord& x, wxCoord& y, bool selected);
|
|
|
|
protected:
|
|
wxString m_text;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextImageBlock
|
|
|
|
This class stores information about an image, in binary in-memory form.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextImageBlock: public wxObject
|
|
{
|
|
public:
|
|
wxRichTextImageBlock();
|
|
wxRichTextImageBlock(const wxRichTextImageBlock& block);
|
|
virtual ~wxRichTextImageBlock();
|
|
|
|
void Init();
|
|
void Clear();
|
|
|
|
// Load the original image into a memory block.
|
|
// If the image is not a JPEG, we must convert it into a JPEG
|
|
// to conserve space.
|
|
// If it's not a JPEG we can make use of 'image', already scaled, so we don't have to
|
|
// load the image a 2nd time.
|
|
virtual bool MakeImageBlock(const wxString& filename, wxBitmapType imageType,
|
|
wxImage& image, bool convertToJPEG = true);
|
|
|
|
// Make an image block from the wxImage in the given
|
|
// format.
|
|
virtual bool MakeImageBlock(wxImage& image, wxBitmapType imageType, int quality = 80);
|
|
|
|
// Uses a const wxImage for efficiency, but can't set quality (only relevant for JPEG)
|
|
virtual bool MakeImageBlockDefaultQuality(const wxImage& image, wxBitmapType imageType);
|
|
|
|
// Makes the image block
|
|
virtual bool DoMakeImageBlock(const wxImage& image, wxBitmapType imageType);
|
|
|
|
// Write to a file
|
|
bool Write(const wxString& filename);
|
|
|
|
// Write data in hex to a stream
|
|
bool WriteHex(wxOutputStream& stream);
|
|
|
|
// Read data in hex from a stream
|
|
bool ReadHex(wxInputStream& stream, int length, wxBitmapType imageType);
|
|
|
|
// Copy from 'block'
|
|
void Copy(const wxRichTextImageBlock& block);
|
|
|
|
// Load a wxImage from the block
|
|
bool Load(wxImage& image);
|
|
|
|
//// Operators
|
|
void operator=(const wxRichTextImageBlock& block);
|
|
|
|
//// Accessors
|
|
|
|
unsigned char* GetData() const { return m_data; }
|
|
size_t GetDataSize() const { return m_dataSize; }
|
|
wxBitmapType GetImageType() const { return m_imageType; }
|
|
|
|
void SetData(unsigned char* image) { m_data = image; }
|
|
void SetDataSize(size_t size) { m_dataSize = size; }
|
|
void SetImageType(wxBitmapType imageType) { m_imageType = imageType; }
|
|
|
|
bool Ok() const { return IsOk(); }
|
|
bool IsOk() const { return GetData() != NULL; }
|
|
|
|
// Gets the extension for the block's type
|
|
wxString GetExtension() const;
|
|
|
|
/// Implementation
|
|
|
|
// Allocate and read from stream as a block of memory
|
|
static unsigned char* ReadBlock(wxInputStream& stream, size_t size);
|
|
static unsigned char* ReadBlock(const wxString& filename, size_t size);
|
|
|
|
// Write memory block to stream
|
|
static bool WriteBlock(wxOutputStream& stream, unsigned char* block, size_t size);
|
|
|
|
// Write memory block to file
|
|
static bool WriteBlock(const wxString& filename, unsigned char* block, size_t size);
|
|
|
|
protected:
|
|
// Size in bytes of the image stored.
|
|
// This is in the raw, original form such as a JPEG file.
|
|
unsigned char* m_data;
|
|
size_t m_dataSize;
|
|
wxBitmapType m_imageType;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextImage
|
|
|
|
This class implements a graphic object.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl, wxRichTextImageBlock
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextImage: public wxRichTextObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextImage)
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextImage(wxRichTextObject* parent = NULL): wxRichTextObject(parent) { }
|
|
wxRichTextImage(const wxImage& image, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL);
|
|
wxRichTextImage(const wxRichTextImageBlock& imageBlock, wxRichTextObject* parent = NULL, wxRichTextAttr* charStyle = NULL);
|
|
wxRichTextImage(const wxRichTextImage& obj): wxRichTextObject(obj) { Copy(obj); }
|
|
|
|
// Overridables
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
|
|
|
|
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;
|
|
|
|
virtual bool IsEmpty() const { return false; /* !m_imageBlock.IsOk(); */ }
|
|
|
|
virtual bool CanEditProperties() const { return true; }
|
|
|
|
virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer);
|
|
|
|
virtual wxString GetPropertiesMenuLabel() const { return _("&Picture"); }
|
|
|
|
virtual bool UsesParagraphAttributes() const { return false; }
|
|
|
|
#if wxUSE_XML
|
|
virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
|
|
virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
|
|
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
// Images can be floatable (optionally).
|
|
virtual bool IsFloatable() const { return true; }
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("image"); }
|
|
|
|
// Accessors
|
|
|
|
/// Get the image cache (scaled bitmap)
|
|
const wxBitmap& GetImageCache() const { return m_imageCache; }
|
|
|
|
/// Set the image cache
|
|
void SetImageCache(const wxBitmap& bitmap) { m_imageCache = bitmap; }
|
|
|
|
/// Reset the image cache
|
|
void ResetImageCache() { m_imageCache = wxNullBitmap; }
|
|
|
|
/// Get the image block containing the raw data
|
|
wxRichTextImageBlock& GetImageBlock() { return m_imageBlock; }
|
|
|
|
// Operations
|
|
|
|
/// Copy
|
|
void Copy(const wxRichTextImage& obj);
|
|
|
|
/// Clone
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextImage(*this); }
|
|
|
|
/// Create a cached image at the required size
|
|
virtual bool LoadImageCache(wxDC& dc, bool resetCache = false);
|
|
|
|
protected:
|
|
wxRichTextImageBlock m_imageBlock;
|
|
wxBitmap m_imageCache;
|
|
};
|
|
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCommand;
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextAction;
|
|
|
|
/**
|
|
@class wxRichTextBuffer
|
|
|
|
This is a kind of paragraph layout box, used to represent the whole buffer.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextParagraphLayoutBox, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextBuffer: public wxRichTextParagraphLayoutBox
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextBuffer)
|
|
public:
|
|
// Constructors
|
|
|
|
wxRichTextBuffer() { Init(); }
|
|
wxRichTextBuffer(const wxRichTextBuffer& obj): wxRichTextParagraphLayoutBox() { Init(); Copy(obj); }
|
|
virtual ~wxRichTextBuffer() ;
|
|
|
|
// Accessors
|
|
|
|
/// Gets the command processor
|
|
wxCommandProcessor* GetCommandProcessor() const { return m_commandProcessor; }
|
|
|
|
/// Set style sheet, if any.
|
|
void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { m_styleSheet = styleSheet; }
|
|
virtual wxRichTextStyleSheet* GetStyleSheet() const { return m_styleSheet; }
|
|
|
|
/// Set style sheet and notify of the change
|
|
bool SetStyleSheetAndNotify(wxRichTextStyleSheet* sheet);
|
|
|
|
/// Push style sheet to top of stack
|
|
bool PushStyleSheet(wxRichTextStyleSheet* styleSheet);
|
|
|
|
/// Pop style sheet from top of stack
|
|
wxRichTextStyleSheet* PopStyleSheet();
|
|
|
|
/// Set/get table storing fonts
|
|
wxRichTextFontTable& GetFontTable() { return m_fontTable; }
|
|
const wxRichTextFontTable& GetFontTable() const { return m_fontTable; }
|
|
void SetFontTable(const wxRichTextFontTable& table) { m_fontTable = table; }
|
|
|
|
// Operations
|
|
|
|
/// Initialisation
|
|
void Init();
|
|
|
|
/// Clears the buffer, adds an empty paragraph, and clears the command processor.
|
|
virtual void ResetAndClearCommands();
|
|
|
|
/// Load a file
|
|
virtual bool LoadFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
|
|
|
|
/// Save a file
|
|
virtual bool SaveFile(const wxString& filename, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
|
|
|
|
/// Load from a stream
|
|
virtual bool LoadFile(wxInputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
|
|
|
|
/// Save to a stream
|
|
virtual bool SaveFile(wxOutputStream& stream, wxRichTextFileType type = wxRICHTEXT_TYPE_ANY);
|
|
|
|
/// Set the handler flags, controlling loading and saving
|
|
void SetHandlerFlags(int flags) { m_handlerFlags = flags; }
|
|
|
|
/// Get the handler flags, controlling loading and saving
|
|
int GetHandlerFlags() const { return m_handlerFlags; }
|
|
|
|
/// Convenience function to add a paragraph of text
|
|
virtual wxRichTextRange AddParagraph(const wxString& text, wxRichTextAttr* paraStyle = NULL) { Modify(); return wxRichTextParagraphLayoutBox::AddParagraph(text, paraStyle); }
|
|
|
|
/// Begin collapsing undo/redo commands. Note that this may not work properly
|
|
/// if combining commands that delete or insert content, changing ranges for
|
|
/// subsequent actions.
|
|
virtual bool BeginBatchUndo(const wxString& cmdName);
|
|
|
|
/// End collapsing undo/redo commands
|
|
virtual bool EndBatchUndo();
|
|
|
|
/// Collapsing commands?
|
|
virtual bool BatchingUndo() const { return m_batchedCommandDepth > 0; }
|
|
|
|
/// Submit immediately, or delay according to whether collapsing is on
|
|
virtual bool SubmitAction(wxRichTextAction* action);
|
|
|
|
/// Get collapsed command
|
|
virtual wxRichTextCommand* GetBatchedCommand() const { return m_batchedCommand; }
|
|
|
|
/// Begin suppressing undo/redo commands. The way undo is suppressed may be implemented
|
|
/// differently by each command. If not dealt with by a command implementation, then
|
|
/// it will be implemented automatically by not storing the command in the undo history
|
|
/// when the action is submitted to the command processor.
|
|
virtual bool BeginSuppressUndo();
|
|
|
|
/// End suppressing undo/redo commands.
|
|
virtual bool EndSuppressUndo();
|
|
|
|
/// Collapsing commands?
|
|
virtual bool SuppressingUndo() const { return m_suppressUndo > 0; }
|
|
|
|
/// Copy the range to the clipboard
|
|
virtual bool CopyToClipboard(const wxRichTextRange& range);
|
|
|
|
/// Paste the clipboard content to the buffer
|
|
virtual bool PasteFromClipboard(long position);
|
|
|
|
/// Can we paste from the clipboard?
|
|
virtual bool CanPasteFromClipboard() const;
|
|
|
|
/// Begin using a style
|
|
virtual bool BeginStyle(const wxRichTextAttr& style);
|
|
|
|
/// End the style
|
|
virtual bool EndStyle();
|
|
|
|
/// End all styles
|
|
virtual bool EndAllStyles();
|
|
|
|
/// Clear the style stack
|
|
virtual void ClearStyleStack();
|
|
|
|
/// Get the size of the style stack, for example to check correct nesting
|
|
virtual size_t GetStyleStackSize() const { return m_attributeStack.GetCount(); }
|
|
|
|
/// Begin using bold
|
|
bool BeginBold();
|
|
|
|
/// End using bold
|
|
bool EndBold() { return EndStyle(); }
|
|
|
|
/// Begin using italic
|
|
bool BeginItalic();
|
|
|
|
/// End using italic
|
|
bool EndItalic() { return EndStyle(); }
|
|
|
|
/// Begin using underline
|
|
bool BeginUnderline();
|
|
|
|
/// End using underline
|
|
bool EndUnderline() { return EndStyle(); }
|
|
|
|
/// Begin using point size
|
|
bool BeginFontSize(int pointSize);
|
|
|
|
/// End using point size
|
|
bool EndFontSize() { return EndStyle(); }
|
|
|
|
/// Begin using this font
|
|
bool BeginFont(const wxFont& font);
|
|
|
|
/// End using a font
|
|
bool EndFont() { return EndStyle(); }
|
|
|
|
/// Begin using this colour
|
|
bool BeginTextColour(const wxColour& colour);
|
|
|
|
/// End using a colour
|
|
bool EndTextColour() { return EndStyle(); }
|
|
|
|
/// Begin using alignment
|
|
bool BeginAlignment(wxTextAttrAlignment alignment);
|
|
|
|
/// End alignment
|
|
bool EndAlignment() { return EndStyle(); }
|
|
|
|
/// Begin left indent
|
|
bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0);
|
|
|
|
/// End left indent
|
|
bool EndLeftIndent() { return EndStyle(); }
|
|
|
|
/// Begin right indent
|
|
bool BeginRightIndent(int rightIndent);
|
|
|
|
/// End right indent
|
|
bool EndRightIndent() { return EndStyle(); }
|
|
|
|
/// Begin paragraph spacing
|
|
bool BeginParagraphSpacing(int before, int after);
|
|
|
|
/// End paragraph spacing
|
|
bool EndParagraphSpacing() { return EndStyle(); }
|
|
|
|
/// Begin line spacing
|
|
bool BeginLineSpacing(int lineSpacing);
|
|
|
|
/// End line spacing
|
|
bool EndLineSpacing() { return EndStyle(); }
|
|
|
|
/// Begin numbered bullet
|
|
bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD);
|
|
|
|
/// End numbered bullet
|
|
bool EndNumberedBullet() { return EndStyle(); }
|
|
|
|
/// Begin symbol bullet
|
|
bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL);
|
|
|
|
/// End symbol bullet
|
|
bool EndSymbolBullet() { return EndStyle(); }
|
|
|
|
/// Begin standard bullet
|
|
bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD);
|
|
|
|
/// End standard bullet
|
|
bool EndStandardBullet() { return EndStyle(); }
|
|
|
|
/// Begin named character style
|
|
bool BeginCharacterStyle(const wxString& characterStyle);
|
|
|
|
/// End named character style
|
|
bool EndCharacterStyle() { return EndStyle(); }
|
|
|
|
/// Begin named paragraph style
|
|
bool BeginParagraphStyle(const wxString& paragraphStyle);
|
|
|
|
/// End named character style
|
|
bool EndParagraphStyle() { return EndStyle(); }
|
|
|
|
/// Begin named list style
|
|
bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1);
|
|
|
|
/// End named character style
|
|
bool EndListStyle() { return EndStyle(); }
|
|
|
|
/// Begin URL
|
|
bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString);
|
|
|
|
/// End URL
|
|
bool EndURL() { return EndStyle(); }
|
|
|
|
// Event handling
|
|
|
|
/// Add an event handler
|
|
bool AddEventHandler(wxEvtHandler* handler);
|
|
|
|
/// Remove an event handler
|
|
bool RemoveEventHandler(wxEvtHandler* handler, bool deleteHandler = false);
|
|
|
|
/// Clear event handlers
|
|
void ClearEventHandlers();
|
|
|
|
/// Send event to event handlers. If sendToAll is true, will send to all event handlers,
|
|
/// otherwise will stop at the first successful one.
|
|
bool SendEvent(wxEvent& event, bool sendToAll = true);
|
|
|
|
// Implementation
|
|
|
|
virtual int HitTest(wxDC& dc, const wxPoint& pt, long& textPosition, wxRichTextObject** obj, wxRichTextObject** contextObj, int flags = 0);
|
|
|
|
/// Copy
|
|
void Copy(const wxRichTextBuffer& obj);
|
|
|
|
/// Assignment
|
|
void operator= (const wxRichTextBuffer& obj) { Copy(obj); }
|
|
|
|
/// Clone
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextBuffer(*this); }
|
|
|
|
/// Submit command to insert paragraphs
|
|
bool InsertParagraphsWithUndo(long pos, const wxRichTextParagraphLayoutBox& paragraphs, wxRichTextCtrl* ctrl, int flags = 0);
|
|
|
|
/// Submit command to insert the given text
|
|
bool InsertTextWithUndo(long pos, const wxString& text, wxRichTextCtrl* ctrl, int flags = 0);
|
|
|
|
/// Submit command to insert a newline
|
|
bool InsertNewlineWithUndo(long pos, wxRichTextCtrl* ctrl, int flags = 0);
|
|
|
|
/// Submit command to insert the given image
|
|
bool InsertImageWithUndo(long pos, const wxRichTextImageBlock& imageBlock, wxRichTextCtrl* ctrl, int flags = 0,
|
|
const wxRichTextAttr& textAttr = wxRichTextAttr());
|
|
|
|
/// Submit command to insert an object
|
|
wxRichTextObject* InsertObjectWithUndo(long pos, wxRichTextObject *object, wxRichTextCtrl* ctrl, int flags);
|
|
|
|
/// Submit command to delete this range
|
|
bool DeleteRangeWithUndo(const wxRichTextRange& range, wxRichTextCtrl* ctrl);
|
|
|
|
/// Mark modified
|
|
void Modify(bool modify = true) { m_modified = modify; }
|
|
bool IsModified() const { return m_modified; }
|
|
|
|
/// Dumps contents of buffer for debugging purposes
|
|
virtual void Dump();
|
|
virtual void Dump(wxTextOutputStream& stream) { wxRichTextParagraphLayoutBox::Dump(stream); }
|
|
|
|
/// Returns the file handlers
|
|
static wxList& GetHandlers() { return sm_handlers; }
|
|
|
|
/// Adds a handler to the end
|
|
static void AddHandler(wxRichTextFileHandler *handler);
|
|
|
|
/// Inserts a handler at the front
|
|
static void InsertHandler(wxRichTextFileHandler *handler);
|
|
|
|
/// Removes a handler
|
|
static bool RemoveHandler(const wxString& name);
|
|
|
|
/// Finds a handler by name
|
|
static wxRichTextFileHandler *FindHandler(const wxString& name);
|
|
|
|
/// Finds a handler by extension and type
|
|
static wxRichTextFileHandler *FindHandler(const wxString& extension, wxRichTextFileType imageType);
|
|
|
|
/// Finds a handler by filename or, if supplied, type
|
|
static wxRichTextFileHandler *FindHandlerFilenameOrType(const wxString& filename,
|
|
wxRichTextFileType imageType);
|
|
|
|
/// Finds a handler by type
|
|
static wxRichTextFileHandler *FindHandler(wxRichTextFileType imageType);
|
|
|
|
/// Gets a wildcard incorporating all visible handlers. If 'types' is present,
|
|
/// will be filled with the file type corresponding to each filter. This can be
|
|
/// used to determine the type to pass to LoadFile given a selected filter.
|
|
static wxString GetExtWildcard(bool combine = false, bool save = false, wxArrayInt* types = NULL);
|
|
|
|
/// Clean up handlers
|
|
static void CleanUpHandlers();
|
|
|
|
/// Initialise the standard handlers
|
|
static void InitStandardHandlers();
|
|
|
|
/// Get renderer
|
|
static wxRichTextRenderer* GetRenderer() { return sm_renderer; }
|
|
|
|
/// Set renderer, deleting old one
|
|
static void SetRenderer(wxRichTextRenderer* renderer);
|
|
|
|
/// Minimum margin between bullet and paragraph in 10ths of a mm
|
|
static int GetBulletRightMargin() { return sm_bulletRightMargin; }
|
|
static void SetBulletRightMargin(int margin) { sm_bulletRightMargin = margin; }
|
|
|
|
/// Factor to multiply by character height to get a reasonable bullet size
|
|
static float GetBulletProportion() { return sm_bulletProportion; }
|
|
static void SetBulletProportion(float prop) { sm_bulletProportion = prop; }
|
|
|
|
/// Scale factor for calculating dimensions
|
|
double GetScale() const { return m_scale; }
|
|
void SetScale(double scale) { m_scale = scale; }
|
|
|
|
protected:
|
|
|
|
/// Command processor
|
|
wxCommandProcessor* m_commandProcessor;
|
|
|
|
/// Table storing fonts
|
|
wxRichTextFontTable m_fontTable;
|
|
|
|
/// Has been modified?
|
|
bool m_modified;
|
|
|
|
/// Collapsed command stack
|
|
int m_batchedCommandDepth;
|
|
|
|
/// Name for collapsed command
|
|
wxString m_batchedCommandsName;
|
|
|
|
/// Current collapsed command accumulating actions
|
|
wxRichTextCommand* m_batchedCommand;
|
|
|
|
/// Whether to suppress undo
|
|
int m_suppressUndo;
|
|
|
|
/// Style sheet, if any
|
|
wxRichTextStyleSheet* m_styleSheet;
|
|
|
|
/// List of event handlers that will be notified of events
|
|
wxList m_eventHandlers;
|
|
|
|
/// Stack of attributes for convenience functions
|
|
wxList m_attributeStack;
|
|
|
|
/// Flags to be passed to handlers
|
|
int m_handlerFlags;
|
|
|
|
/// File handlers
|
|
static wxList sm_handlers;
|
|
|
|
/// Renderer
|
|
static wxRichTextRenderer* sm_renderer;
|
|
|
|
/// Minimum margin between bullet and paragraph in 10ths of a mm
|
|
static int sm_bulletRightMargin;
|
|
|
|
/// Factor to multiply by character height to get a reasonable bullet size
|
|
static float sm_bulletProportion;
|
|
|
|
/// Scaling factor in use: needed to calculate correct dimensions when printing
|
|
double m_scale;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextCell
|
|
|
|
wxRichTextCell is the cell in a table.
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextCell: public wxRichTextBox
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextCell)
|
|
public:
|
|
// Constructors
|
|
|
|
/**
|
|
Default constructor; optionally pass the parent object.
|
|
*/
|
|
|
|
wxRichTextCell(wxRichTextObject* parent = NULL);
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
|
|
wxRichTextCell(const wxRichTextCell& obj): wxRichTextBox() { Copy(obj); }
|
|
|
|
// Overridables
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("cell"); }
|
|
|
|
virtual bool CanEditProperties() const { return true; }
|
|
|
|
virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer);
|
|
|
|
virtual wxString GetPropertiesMenuLabel() const { return _("&Cell"); }
|
|
|
|
// Accessors
|
|
|
|
// Operations
|
|
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextCell(*this); }
|
|
|
|
void Copy(const wxRichTextCell& obj);
|
|
|
|
protected:
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextTable
|
|
|
|
wxRichTextTable represents a table with arbitrary columns and rows.
|
|
*/
|
|
|
|
WX_DEFINE_ARRAY_PTR(wxRichTextObject*, wxRichTextObjectPtrArray);
|
|
WX_DECLARE_OBJARRAY(wxRichTextObjectPtrArray, wxRichTextObjectPtrArrayArray);
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextTable: public wxRichTextBox
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxRichTextTable)
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
/**
|
|
Default constructor; optionally pass the parent object.
|
|
*/
|
|
|
|
wxRichTextTable(wxRichTextObject* parent = NULL);
|
|
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
|
|
wxRichTextTable(const wxRichTextTable& obj): wxRichTextBox() { Copy(obj); }
|
|
|
|
// Overridables
|
|
|
|
virtual bool Draw(wxDC& dc, const wxRichTextRange& range, const wxRichTextSelection& selection, const wxRect& rect, int descent, int style);
|
|
|
|
virtual wxString GetXMLNodeName() const { return wxT("table"); }
|
|
|
|
virtual bool Layout(wxDC& dc, const wxRect& rect, int style);
|
|
|
|
virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0), wxArrayInt* partialExtents = NULL) const;
|
|
|
|
virtual bool DeleteRange(const wxRichTextRange& range);
|
|
|
|
virtual wxString GetTextForRange(const wxRichTextRange& range) const;
|
|
|
|
#if wxUSE_XML
|
|
virtual bool ImportFromXML(wxRichTextBuffer* buffer, wxXmlNode* node, wxRichTextXMLHandler* handler, bool* recurse);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_DIRECT_OUTPUT
|
|
virtual bool ExportXML(wxOutputStream& stream, int indent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
#if wxRICHTEXT_HAVE_XMLDOCUMENT_OUTPUT
|
|
virtual bool ExportXML(wxXmlNode* parent, wxRichTextXMLHandler* handler);
|
|
#endif
|
|
|
|
virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
|
|
|
|
virtual void CalculateRange(long start, long& end);
|
|
|
|
// 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;
|
|
|
|
virtual bool CanEditProperties() const { return true; }
|
|
|
|
virtual bool EditProperties(wxWindow* parent, wxRichTextBuffer* buffer);
|
|
|
|
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).
|
|
virtual bool AcceptsFocus() const { return false; }
|
|
|
|
// Accessors
|
|
|
|
const wxRichTextObjectPtrArrayArray& GetCells() const { return m_cells; }
|
|
wxRichTextObjectPtrArrayArray& GetCells() { return m_cells; }
|
|
|
|
int GetRowCount() const { return m_rowCount; }
|
|
int GetColumnCount() const { return m_colCount; }
|
|
|
|
/// Get the cell at the given row/column position
|
|
virtual wxRichTextCell* GetCell(int row, int col) const;
|
|
|
|
/// Get the cell at the given character position (in the range of the table).
|
|
virtual wxRichTextCell* GetCell(long pos) const;
|
|
|
|
/// Get the row/column for a given character position
|
|
virtual bool GetCellRowColumnPosition(long pos, int& row, int& col) const;
|
|
|
|
// Operations
|
|
|
|
/**
|
|
Clears the table.
|
|
*/
|
|
|
|
virtual void ClearTable();
|
|
|
|
/**
|
|
Creates a table of the given dimensions.
|
|
*/
|
|
|
|
virtual bool CreateTable(int rows, int cols);
|
|
|
|
/**
|
|
Sets the attributes for the cells specified by the selection.
|
|
*/
|
|
|
|
virtual bool SetCellStyle(const wxRichTextSelection& selection, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
|
|
|
|
/**
|
|
Deletes rows from the given row position.
|
|
*/
|
|
|
|
virtual bool DeleteRows(int startRow, int noRows = 1);
|
|
|
|
/**
|
|
Deletes columns from the given column position.
|
|
*/
|
|
|
|
virtual bool DeleteColumns(int startCol, int noCols = 1);
|
|
|
|
/**
|
|
Adds rows from the given row position.
|
|
*/
|
|
|
|
virtual bool AddRows(int startRow, int noRows = 1, const wxRichTextAttr& attr = wxRichTextAttr());
|
|
|
|
/**
|
|
Adds columns from the given column position.
|
|
*/
|
|
|
|
virtual bool AddColumns(int startCol, int noCols = 1, const wxRichTextAttr& attr = wxRichTextAttr());
|
|
|
|
// Makes a clone of this object.
|
|
virtual wxRichTextObject* Clone() const { return new wxRichTextTable(*this); }
|
|
|
|
// Copies this object.
|
|
void Copy(const wxRichTextTable& obj);
|
|
|
|
protected:
|
|
|
|
int m_rowCount;
|
|
int m_colCount;
|
|
|
|
// An array of rows, each of which is a wxRichTextObjectPtrArray containing
|
|
// the cell objects. The cell objects are also children of this object.
|
|
// Problem: if boxes are immediate children of a box, this will cause problems
|
|
// with wxRichTextParagraphLayoutBox functions (and functions elsewhere) that
|
|
// expect to find just paragraphs. May have to adjust the way we handle the
|
|
// hierarchy to accept non-paragraph objects in a paragraph layout box.
|
|
// We'll be overriding much wxRichTextParagraphLayoutBox functionality so this
|
|
// may not be such a problem. Perhaps the table should derive from a different
|
|
// class?
|
|
wxRichTextObjectPtrArrayArray m_cells;
|
|
};
|
|
|
|
|
|
/*!
|
|
* The command identifiers
|
|
*
|
|
*/
|
|
|
|
enum wxRichTextCommandId
|
|
{
|
|
wxRICHTEXT_INSERT,
|
|
wxRICHTEXT_DELETE,
|
|
wxRICHTEXT_CHANGE_ATTRIBUTES,
|
|
wxRICHTEXT_CHANGE_STYLE,
|
|
wxRICHTEXT_CHANGE_OBJECT
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextObjectAddress
|
|
|
|
A class for specifying an object anywhere in an object hierarchy,
|
|
without using a pointer, necessary since wxRTC commands may delete
|
|
and recreate sub-objects so physical object addresses change. An array
|
|
of positions (one per hierarchy level) is used.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextCommand
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextObjectAddress
|
|
{
|
|
public:
|
|
// Creates the address given container and object.
|
|
wxRichTextObjectAddress(wxRichTextParagraphLayoutBox* topLevelContainer, wxRichTextObject* obj) { Create(topLevelContainer, obj); }
|
|
wxRichTextObjectAddress() { Init(); }
|
|
wxRichTextObjectAddress(const wxRichTextObjectAddress& address) { Copy(address); }
|
|
|
|
void Init() {}
|
|
void Copy(const wxRichTextObjectAddress& address) { m_address = address.m_address; }
|
|
void operator=(const wxRichTextObjectAddress& address) { Copy(address); }
|
|
|
|
wxRichTextObject* GetObject(wxRichTextParagraphLayoutBox* topLevelContainer) const;
|
|
bool Create(wxRichTextParagraphLayoutBox* topLevelContainer, wxRichTextObject* obj);
|
|
|
|
wxArrayInt& GetAddress() { return m_address; }
|
|
const wxArrayInt& GetAddress() const { return m_address; }
|
|
void SetAddress(const wxArrayInt& address) { m_address = address; }
|
|
|
|
protected:
|
|
|
|
wxArrayInt m_address;
|
|
};
|
|
|
|
class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextAction;
|
|
|
|
/**
|
|
@class wxRichTextCommand
|
|
|
|
Implements a command on the undo/redo stack. A wxRichTextCommand object contains one or more wxRichTextAction
|
|
objects, allowing aggregation of a number of operations into one command.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextAction
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextCommand: public wxCommand
|
|
{
|
|
public:
|
|
// Ctor for one action
|
|
wxRichTextCommand(const wxString& name, wxRichTextCommandId id, wxRichTextBuffer* buffer,
|
|
wxRichTextParagraphLayoutBox* container, wxRichTextCtrl* ctrl, bool ignoreFirstTime = false);
|
|
|
|
// Ctor for multiple actions
|
|
wxRichTextCommand(const wxString& name);
|
|
|
|
virtual ~wxRichTextCommand();
|
|
|
|
bool Do();
|
|
bool Undo();
|
|
|
|
void AddAction(wxRichTextAction* action);
|
|
void ClearActions();
|
|
|
|
wxList& GetActions() { return m_actions; }
|
|
|
|
protected:
|
|
|
|
wxList m_actions;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextAction
|
|
|
|
Implements a part of a command.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextCommand
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextAction: public wxObject
|
|
{
|
|
public:
|
|
/// Constructor. 'buffer' is the top-level buffer, while 'container' is the object within
|
|
/// which the action is taking place. In the simplest case, they are the same.
|
|
wxRichTextAction(wxRichTextCommand* cmd, const wxString& name, wxRichTextCommandId id,
|
|
wxRichTextBuffer* buffer, wxRichTextParagraphLayoutBox* container,
|
|
wxRichTextCtrl* ctrl, bool ignoreFirstTime = false);
|
|
|
|
virtual ~wxRichTextAction();
|
|
|
|
bool Do();
|
|
bool Undo();
|
|
|
|
/// Update the control appearance
|
|
void UpdateAppearance(long caretPosition, bool sendUpdateEvent = false,
|
|
wxArrayInt* optimizationLineCharPositions = NULL, wxArrayInt* optimizationLineYPositions = NULL, bool isDoCmd = true);
|
|
|
|
/// Replace the buffer paragraphs with the given fragment.
|
|
void ApplyParagraphs(const wxRichTextParagraphLayoutBox& fragment);
|
|
|
|
/// Get the fragments
|
|
wxRichTextParagraphLayoutBox& GetNewParagraphs() { return m_newParagraphs; }
|
|
wxRichTextParagraphLayoutBox& GetOldParagraphs() { return m_oldParagraphs; }
|
|
|
|
/// Get the attributes
|
|
wxRichTextAttr& GetAttributes() { return m_attributes; }
|
|
|
|
/// An object to replace the one at the position
|
|
/// defined by the container address and the action's range start position.
|
|
wxRichTextObject* GetObject() const { return m_object; }
|
|
void SetObject(wxRichTextObject* obj) { m_object = obj; m_objectAddress.Create(m_buffer, m_object); }
|
|
void MakeObject(wxRichTextObject* obj) { m_objectAddress.Create(m_buffer, obj); }
|
|
|
|
/// Calculate arrays for refresh optimization
|
|
void CalculateRefreshOptimizations(wxArrayInt& optimizationLineCharPositions, wxArrayInt& optimizationLineYPositions);
|
|
|
|
/// Set/get the position used for e.g. insertion
|
|
void SetPosition(long pos) { m_position = pos; }
|
|
long GetPosition() const { return m_position; }
|
|
|
|
/// Set/get the range for e.g. deletion
|
|
void SetRange(const wxRichTextRange& range) { m_range = range; }
|
|
const wxRichTextRange& GetRange() const { return m_range; }
|
|
|
|
/// The address (nested position) of the container within the buffer being manipulated
|
|
wxRichTextObjectAddress& GetContainerAddress() { return m_containerAddress; }
|
|
const wxRichTextObjectAddress& GetContainerAddress() const { return m_containerAddress; }
|
|
void SetContainerAddress(const wxRichTextObjectAddress& address) { m_containerAddress = address; }
|
|
void SetContainerAddress(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj) { m_containerAddress.Create(container, obj); }
|
|
|
|
/// Returns the container that this action refers to, using the container address and top-level buffer.
|
|
wxRichTextParagraphLayoutBox* GetContainer() const;
|
|
/// Get name
|
|
const wxString& GetName() const { return m_name; }
|
|
|
|
protected:
|
|
// Action name
|
|
wxString m_name;
|
|
|
|
// Buffer
|
|
wxRichTextBuffer* m_buffer;
|
|
|
|
// The address (nested position) of the container being manipulated.
|
|
// This is necessary because objects are deleted, and we can't
|
|
// therefore store actual pointers.
|
|
wxRichTextObjectAddress m_containerAddress;
|
|
|
|
// Control
|
|
wxRichTextCtrl* m_ctrl;
|
|
|
|
// Stores the new paragraphs
|
|
wxRichTextParagraphLayoutBox m_newParagraphs;
|
|
|
|
// Stores the old paragraphs
|
|
wxRichTextParagraphLayoutBox m_oldParagraphs;
|
|
|
|
// Stores an object to replace the one at the position
|
|
// defined by the container address and the action's range start position.
|
|
wxRichTextObject* m_object;
|
|
|
|
// Stores the attributes
|
|
wxRichTextAttr m_attributes;
|
|
|
|
// The address of the object being manipulated (used for changing an individual object or its attributes)
|
|
wxRichTextObjectAddress m_objectAddress;
|
|
|
|
// Stores the old attributes
|
|
// wxRichTextAttr m_oldAttributes;
|
|
|
|
// The affected range
|
|
wxRichTextRange m_range;
|
|
|
|
// The insertion point for this command
|
|
long m_position;
|
|
|
|
// Ignore 1st 'Do' operation because we already did it
|
|
bool m_ignoreThis;
|
|
|
|
// The command identifier
|
|
wxRichTextCommandId m_cmdId;
|
|
};
|
|
|
|
/*!
|
|
* Handler flags
|
|
*/
|
|
|
|
// Include style sheet when loading and saving
|
|
#define wxRICHTEXT_HANDLER_INCLUDE_STYLESHEET 0x0001
|
|
|
|
// Save images to memory file system in HTML handler
|
|
#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY 0x0010
|
|
|
|
// Save images to files in HTML handler
|
|
#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES 0x0020
|
|
|
|
// Save images as inline base64 data in HTML handler
|
|
#define wxRICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 0x0040
|
|
|
|
// Don't write header and footer (or BODY), so we can include the fragment
|
|
// in a larger document
|
|
#define wxRICHTEXT_HANDLER_NO_HEADER_FOOTER 0x0080
|
|
|
|
// Convert the more common face names to names that will work on the current platform
|
|
// in a larger document
|
|
#define wxRICHTEXT_HANDLER_CONVERT_FACENAMES 0x0100
|
|
|
|
/**
|
|
@class wxRichTextFileHandler
|
|
|
|
The base class for file handlers.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextFileHandler: public wxObject
|
|
{
|
|
DECLARE_CLASS(wxRichTextFileHandler)
|
|
public:
|
|
wxRichTextFileHandler(const wxString& name = wxEmptyString, const wxString& ext = wxEmptyString, int type = 0)
|
|
: m_name(name), m_extension(ext), m_type(type), m_flags(0), m_visible(true)
|
|
{ }
|
|
|
|
#if wxUSE_STREAMS
|
|
bool LoadFile(wxRichTextBuffer *buffer, wxInputStream& stream)
|
|
{ return DoLoadFile(buffer, stream); }
|
|
bool SaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream)
|
|
{ return DoSaveFile(buffer, stream); }
|
|
#endif
|
|
|
|
#if wxUSE_FFILE && wxUSE_STREAMS
|
|
virtual bool LoadFile(wxRichTextBuffer *buffer, const wxString& filename);
|
|
virtual bool SaveFile(wxRichTextBuffer *buffer, const wxString& filename);
|
|
#endif // wxUSE_STREAMS && wxUSE_STREAMS
|
|
|
|
/// Can we handle this filename (if using files)? By default, checks the extension.
|
|
virtual bool CanHandle(const wxString& filename) const;
|
|
|
|
/// Can we save using this handler?
|
|
virtual bool CanSave() const { return false; }
|
|
|
|
/// Can we load using this handler?
|
|
virtual bool CanLoad() const { return false; }
|
|
|
|
/// Should this handler be visible to the user?
|
|
virtual bool IsVisible() const { return m_visible; }
|
|
virtual void SetVisible(bool visible) { m_visible = visible; }
|
|
|
|
/// The name of the nandler
|
|
void SetName(const wxString& name) { m_name = name; }
|
|
wxString GetName() const { return m_name; }
|
|
|
|
/// The default extension to recognise
|
|
void SetExtension(const wxString& ext) { m_extension = ext; }
|
|
wxString GetExtension() const { return m_extension; }
|
|
|
|
/// The handler type
|
|
void SetType(int type) { m_type = type; }
|
|
int GetType() const { return m_type; }
|
|
|
|
/// Flags controlling how loading and saving is done
|
|
void SetFlags(int flags) { m_flags = flags; }
|
|
int GetFlags() const { return m_flags; }
|
|
|
|
/// Encoding to use when saving a file. If empty, a suitable encoding is chosen
|
|
void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
|
|
const wxString& GetEncoding() const { return m_encoding; }
|
|
|
|
protected:
|
|
|
|
#if wxUSE_STREAMS
|
|
virtual bool DoLoadFile(wxRichTextBuffer *buffer, wxInputStream& stream) = 0;
|
|
virtual bool DoSaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream) = 0;
|
|
#endif
|
|
|
|
wxString m_name;
|
|
wxString m_encoding;
|
|
wxString m_extension;
|
|
int m_type;
|
|
int m_flags;
|
|
bool m_visible;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextPlainTextHandler
|
|
|
|
Implements saving a buffer to plain text.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextFileHandler, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextPlainTextHandler: public wxRichTextFileHandler
|
|
{
|
|
DECLARE_CLASS(wxRichTextPlainTextHandler)
|
|
public:
|
|
wxRichTextPlainTextHandler(const wxString& name = wxT("Text"),
|
|
const wxString& ext = wxT("txt"),
|
|
wxRichTextFileType type = wxRICHTEXT_TYPE_TEXT)
|
|
: wxRichTextFileHandler(name, ext, type)
|
|
{ }
|
|
|
|
/// Can we save using this handler?
|
|
virtual bool CanSave() const { return true; }
|
|
|
|
/// Can we load using this handler?
|
|
virtual bool CanLoad() const { return true; }
|
|
|
|
protected:
|
|
|
|
#if wxUSE_STREAMS
|
|
virtual bool DoLoadFile(wxRichTextBuffer *buffer, wxInputStream& stream);
|
|
virtual bool DoSaveFile(wxRichTextBuffer *buffer, wxOutputStream& stream);
|
|
#endif
|
|
|
|
};
|
|
|
|
#if wxUSE_DATAOBJ
|
|
|
|
/**
|
|
@class wxRichTextBufferDataObject
|
|
|
|
Implements a rich text data object for clipboard transfer.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxDataObjectSimple, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextBufferDataObject: public wxDataObjectSimple
|
|
{
|
|
public:
|
|
// ctor doesn't copy the pointer, so it shouldn't go away while this object
|
|
// is alive
|
|
wxRichTextBufferDataObject(wxRichTextBuffer* richTextBuffer = NULL);
|
|
virtual ~wxRichTextBufferDataObject();
|
|
|
|
// after a call to this function, the buffer is owned by the caller and it
|
|
// is responsible for deleting it
|
|
wxRichTextBuffer* GetRichTextBuffer();
|
|
|
|
// Returns the id for the new data format
|
|
static const wxChar* GetRichTextBufferFormatId() { return ms_richTextBufferFormatId; }
|
|
|
|
// base class pure virtuals
|
|
|
|
virtual wxDataFormat GetPreferredFormat(Direction dir) const;
|
|
virtual size_t GetDataSize() const;
|
|
virtual bool GetDataHere(void *pBuf) const;
|
|
virtual bool SetData(size_t len, const void *buf);
|
|
|
|
// prevent warnings
|
|
|
|
virtual size_t GetDataSize(const wxDataFormat&) const { return GetDataSize(); }
|
|
virtual bool GetDataHere(const wxDataFormat&, void *buf) const { return GetDataHere(buf); }
|
|
virtual bool SetData(const wxDataFormat&, size_t len, const void *buf) { return SetData(len, buf); }
|
|
|
|
private:
|
|
wxDataFormat m_formatRichTextBuffer; // our custom format
|
|
wxRichTextBuffer* m_richTextBuffer; // our data
|
|
static const wxChar* ms_richTextBufferFormatId; // our format id
|
|
};
|
|
|
|
#endif
|
|
|
|
/**
|
|
@class wxRichTextRenderer
|
|
|
|
This class isolates some common drawing functionality.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextRenderer: public wxObject
|
|
{
|
|
public:
|
|
wxRichTextRenderer() {}
|
|
virtual ~wxRichTextRenderer() {}
|
|
|
|
/// Draw a standard bullet, as specified by the value of GetBulletName
|
|
virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect) = 0;
|
|
|
|
/// Draw a bullet that can be described by text, such as numbered or symbol bullets
|
|
virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, const wxString& text) = 0;
|
|
|
|
/// Draw a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName
|
|
virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect) = 0;
|
|
|
|
/// Enumerate the standard bullet names currently supported
|
|
virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames) = 0;
|
|
};
|
|
|
|
/**
|
|
@class wxRichTextStdRenderer
|
|
|
|
The standard renderer for drawing bullets.
|
|
|
|
@library{wxrichtext}
|
|
@category{richtext}
|
|
|
|
@see wxRichTextRenderer, wxRichTextBuffer, wxRichTextCtrl
|
|
*/
|
|
|
|
class WXDLLIMPEXP_RICHTEXT wxRichTextStdRenderer: public wxRichTextRenderer
|
|
{
|
|
public:
|
|
wxRichTextStdRenderer() {}
|
|
|
|
/// Draw a standard bullet, as specified by the value of GetBulletName
|
|
virtual bool DrawStandardBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect);
|
|
|
|
/// Draw a bullet that can be described by text, such as numbered or symbol bullets
|
|
virtual bool DrawTextBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect, const wxString& text);
|
|
|
|
/// Draw a bitmap bullet, where the bullet bitmap is specified by the value of GetBulletName
|
|
virtual bool DrawBitmapBullet(wxRichTextParagraph* paragraph, wxDC& dc, const wxRichTextAttr& attr, const wxRect& rect);
|
|
|
|
/// Enumerate the standard bullet names currently supported
|
|
virtual bool EnumerateStandardBulletNames(wxArrayString& bulletNames);
|
|
};
|
|
|
|
/*!
|
|
* Utilities
|
|
*
|
|
*/
|
|
|
|
inline bool wxRichTextHasStyle(int flags, int style)
|
|
{
|
|
return ((flags & style) == style);
|
|
}
|
|
|
|
/// Compare two attribute objects
|
|
WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
|
|
WXDLLIMPEXP_RICHTEXT bool wxTextAttrEq(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
|
|
|
|
/// Compare two attribute objects, but take into account the flags
|
|
/// specifying attributes of interest.
|
|
WXDLLIMPEXP_RICHTEXT bool wxTextAttrEqPartial(const wxRichTextAttr& attr1, const wxRichTextAttr& attr2);
|
|
|
|
/// Apply one style to another
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextApplyStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style, wxRichTextAttr* compareWith = NULL);
|
|
|
|
// Remove attributes
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextRemoveStyle(wxRichTextAttr& destStyle, const wxRichTextAttr& style);
|
|
|
|
/// Combine two bitlists
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextCombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB);
|
|
|
|
/// Compare two bitlists
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextBitlistsEqPartial(int valueA, int valueB, int flags);
|
|
|
|
/// Split into paragraph and character styles
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextSplitParaCharStyles(const wxRichTextAttr& style, wxRichTextAttr& parStyle, wxRichTextAttr& charStyle);
|
|
|
|
/// Compare tabs
|
|
WXDLLIMPEXP_RICHTEXT bool wxRichTextTabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2);
|
|
|
|
/// Convert a decimal to Roman numerals
|
|
WXDLLIMPEXP_RICHTEXT wxString wxRichTextDecimalToRoman(long n);
|
|
|
|
// Collects the attributes that are common to a range of content, building up a note of
|
|
// which attributes are absent in some objects and which clash in some objects.
|
|
WXDLLIMPEXP_RICHTEXT void wxTextAttrCollectCommonAttributes(wxTextAttr& currentStyle, const wxTextAttr& attr, wxTextAttr& clashingAttr, wxTextAttr& absentAttr);
|
|
|
|
WXDLLIMPEXP_RICHTEXT void wxRichTextModuleInit();
|
|
|
|
#endif
|
|
// wxUSE_RICHTEXT
|
|
|
|
#endif
|
|
// _WX_RICHTEXTBUFFER_H_
|
|
|