|
Version: 3.0.2 |
#include <wx/richtext/richtextbuffer.h>
Inheritance diagram for wxRichTextDrawingContext:
Detailed Description
A class for passing information to drawing and measuring functions.
- See Also
- wxRichTextBuffer, wxRichTextCtrl
Public Member Functions | |
| wxRichTextDrawingContext (wxRichTextBuffer *buffer) | |
| Pass the buffer to the context so the context can retrieve information such as virtual attributes. | |
| void | Init () |
| bool | HasVirtualAttributes (wxRichTextObject *obj) const |
| Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling. | |
| wxRichTextAttr | GetVirtualAttributes (wxRichTextObject *obj) const |
| Returns the virtual attributes for this object. | |
| bool | ApplyVirtualAttributes (wxRichTextAttr &attr, wxRichTextObject *obj) const |
| Applies any virtual attributes relevant to this object. | |
| int | GetVirtualSubobjectAttributesCount (wxRichTextObject *obj) const |
| Gets the count for mixed virtual attributes for individual positions within the object. | |
| int | GetVirtualSubobjectAttributes (wxRichTextObject *obj, wxArrayInt &positions, wxRichTextAttrArray &attributes) const |
| Gets the mixed virtual attributes for individual positions within the object. | |
| bool | HasVirtualText (const wxRichTextPlainText *obj) const |
| Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters. | |
| bool | GetVirtualText (const wxRichTextPlainText *obj, wxString &text) const |
| Gets the virtual text for this object. | |
| void | EnableVirtualAttributes (bool b) |
| Enables virtual attribute processing. | |
| bool | GetVirtualAttributesEnabled () const |
| Returns true if virtual attribute processing is enabled. | |
| Public Member Functions inherited from wxObject | |
| wxObject () | |
| Default ctor; initializes to NULL the internal reference data. | |
| wxObject (const wxObject &other) | |
| Copy ctor. | |
| virtual | ~wxObject () |
| Destructor. | |
| virtual wxClassInfo * | GetClassInfo () const |
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). | |
| wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. | |
| bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. | |
| bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. | |
| void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. | |
| void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. | |
| void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. | |
| void | UnShare () |
| This is the same of AllocExclusive() but this method is public. | |
| void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. | |
| void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. | |
Public Attributes | |
| wxRichTextBuffer * | m_buffer |
Additional Inherited Members | |
| Protected Member Functions inherited from wxObject | |
| void | AllocExclusive () |
| Ensure that this object's data is not shared with any other object. | |
| virtual wxObjectRefData * | CreateRefData () const |
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. | |
| virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. | |
| Protected Attributes inherited from wxObject | |
| wxObjectRefData * | m_refData |
| Pointer to an object which is the object's reference-counted data. | |
Constructor & Destructor Documentation
| wxRichTextDrawingContext::wxRichTextDrawingContext | ( | wxRichTextBuffer * | buffer | ) |
Pass the buffer to the context so the context can retrieve information such as virtual attributes.
Member Function Documentation
| bool wxRichTextDrawingContext::ApplyVirtualAttributes | ( | wxRichTextAttr & | attr, |
| wxRichTextObject * | obj | ||
| ) | const |
Applies any virtual attributes relevant to this object.
| void wxRichTextDrawingContext::EnableVirtualAttributes | ( | bool | b | ) |
Enables virtual attribute processing.
| wxRichTextAttr wxRichTextDrawingContext::GetVirtualAttributes | ( | wxRichTextObject * | obj | ) | const |
Returns the virtual attributes for this object.
Virtual attributes can be provided for visual cues without affecting the actual styling.
| bool wxRichTextDrawingContext::GetVirtualAttributesEnabled | ( | ) | const |
Returns true if virtual attribute processing is enabled.
| int wxRichTextDrawingContext::GetVirtualSubobjectAttributes | ( | wxRichTextObject * | obj, |
| wxArrayInt & | positions, | ||
| wxRichTextAttrArray & | attributes | ||
| ) | const |
Gets the mixed virtual attributes for individual positions within the object.
For example, individual characters within a text object may require special highlighting. The function is passed the count returned by GetVirtualSubobjectAttributesCount.
| int wxRichTextDrawingContext::GetVirtualSubobjectAttributesCount | ( | wxRichTextObject * | obj | ) | const |
Gets the count for mixed virtual attributes for individual positions within the object.
For example, individual characters within a text object may require special highlighting.
| bool wxRichTextDrawingContext::GetVirtualText | ( | const wxRichTextPlainText * | obj, |
| wxString & | text | ||
| ) | const |
Gets the virtual text for this object.
| bool wxRichTextDrawingContext::HasVirtualAttributes | ( | wxRichTextObject * | obj | ) | const |
Does this object have virtual attributes? Virtual attributes can be provided for visual cues without affecting the actual styling.
| bool wxRichTextDrawingContext::HasVirtualText | ( | const wxRichTextPlainText * | obj | ) | const |
Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
| void wxRichTextDrawingContext::Init | ( | ) |
Member Data Documentation
| wxRichTextBuffer* wxRichTextDrawingContext::m_buffer |