The base class for custom field types.
Each type definition handles one field type. Override functions to provide drawing, layout, updating and property editing functionality for a field.
Register field types on application initialisation with the static function wxRichTextBuffer::AddFieldType. They will be deleted automatically on application exit.
- See also
- wxRichTextFieldTypeStandard, wxRichTextField, wxRichTextCtrl
|
| wxRichTextFieldType (const wxString &name=wxEmptyString) |
| Creates a field type definition. More...
|
|
| wxRichTextFieldType (const wxRichTextFieldType &fieldType) |
| Copy constructor. More...
|
|
void | Copy (const wxRichTextFieldType &fieldType) |
|
virtual bool | Draw (wxRichTextField *obj, wxDC &dc, wxRichTextDrawingContext &context, const wxRichTextRange &range, const wxRichTextSelection &selection, const wxRect &rect, int descent, int style)=0 |
| Draw the item, within the given range. More...
|
|
virtual bool | Layout (wxRichTextField *obj, wxDC &dc, wxRichTextDrawingContext &context, const wxRect &rect, const wxRect &parentRect, int style)=0 |
| Lay the item out at the specified position with the given size constraint. More...
|
|
virtual bool | GetRangeSize (wxRichTextField *obj, const wxRichTextRange &range, wxSize &size, int &descent, wxDC &dc, wxRichTextDrawingContext &context, int flags, const wxPoint &position=wxPoint(0, 0), const wxSize &parentSize=wxDefaultSize, wxArrayInt *partialExtents=NULL) const =0 |
| Returns the object size for the given range. More...
|
|
virtual bool | CanEditProperties (wxRichTextField *obj) const |
| Returns true if we can edit the object's properties via a GUI. More...
|
|
virtual bool | EditProperties (wxRichTextField *obj, wxWindow *parent, wxRichTextBuffer *buffer) |
| Edits the object's properties via a GUI. More...
|
|
virtual wxString | GetPropertiesMenuLabel (wxRichTextField *obj) const |
| Returns the label to be used for the properties context menu item. More...
|
|
virtual bool | UpdateField (wxRichTextBuffer *buffer, wxRichTextField *obj) |
| Update the field. More...
|
|
virtual bool | IsTopLevel (wxRichTextField *obj) const |
| Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box. More...
|
|
void | SetName (const wxString &name) |
| Sets the field type name. More...
|
|
wxString | GetName () const |
| Returns the field type name. More...
|
|
| wxObject () |
| Default ctor; initializes to NULL the internal reference data. More...
|
|
| wxObject (const wxObject &other) |
| Copy ctor. More...
|
|
virtual | ~wxObject () |
| Destructor. More...
|
|
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). More...
|
|
wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
|
|
bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. More...
|
|
bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. More...
|
|
void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. More...
|
|
void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. More...
|
|
void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
|
|
void | UnShare () |
| This is the same of AllocExclusive() but this method is public. More...
|
|
void | operator delete (void *buf) |
| The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
|
|
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. More...
|
|