Version: 3.0.4
wxRichTextLine Class Reference

#include <wx/richtext/richtextbuffer.h>

Detailed Description

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:  Rich Text
See also
wxRichTextBuffer, wxRichTextCtrl

Public Member Functions

 wxRichTextLine (wxRichTextParagraph *parent)
 
 wxRichTextLine (const wxRichTextLine &obj)
 
virtual ~wxRichTextLine ()
 
void SetRange (const wxRichTextRange &range)
 Sets the range associated with this line. More...
 
void SetRange (long from, long to)
 Sets the range associated with this line. More...
 
wxRichTextParagraphGetParent ()
 Returns the parent paragraph. More...
 
const wxRichTextRangeGetRange () const
 Returns the range. More...
 
wxRichTextRangeGetRange ()
 Returns the range. More...
 
wxRichTextRange GetAbsoluteRange () const
 Returns the absolute range. More...
 
virtual wxSize GetSize () const
 Returns the line size as calculated by Layout. More...
 
virtual void SetSize (const wxSize &sz)
 Sets the line size as calculated by Layout. More...
 
virtual wxPoint GetPosition () const
 Returns the object position relative to the parent. More...
 
virtual void SetPosition (const wxPoint &pos)
 Sets the object position relative to the parent. More...
 
virtual wxPoint GetAbsolutePosition () const
 Returns the absolute object position. More...
 
virtual wxRect GetRect () const
 Returns the rectangle enclosing the line. More...
 
void SetDescent (int descent)
 Sets the stored descent. More...
 
int GetDescent () const
 Returns the stored descent. More...
 
void Init (wxRichTextParagraph *parent)
 Initialises the object. More...
 
void Copy (const wxRichTextLine &obj)
 Copies from obj. More...
 
virtual wxRichTextLineClone () const
 

Protected Attributes

wxRichTextRange m_range
 
wxPoint m_pos
 
wxSize m_size
 
int m_descent
 
wxRichTextParagraphm_parent
 

Constructor & Destructor Documentation

wxRichTextLine::wxRichTextLine ( wxRichTextParagraph parent)
wxRichTextLine::wxRichTextLine ( const wxRichTextLine obj)
inline
virtual wxRichTextLine::~wxRichTextLine ( )
inlinevirtual

Member Function Documentation

virtual wxRichTextLine* wxRichTextLine::Clone ( ) const
inlinevirtual
void wxRichTextLine::Copy ( const wxRichTextLine obj)

Copies from obj.

virtual wxPoint wxRichTextLine::GetAbsolutePosition ( ) const
virtual

Returns the absolute object position.

wxRichTextRange wxRichTextLine::GetAbsoluteRange ( ) const

Returns the absolute range.

int wxRichTextLine::GetDescent ( ) const
inline

Returns the stored descent.

wxRichTextParagraph* wxRichTextLine::GetParent ( )
inline

Returns the parent paragraph.

virtual wxPoint wxRichTextLine::GetPosition ( ) const
inlinevirtual

Returns the object position relative to the parent.

const wxRichTextRange& wxRichTextLine::GetRange ( ) const
inline

Returns the range.

wxRichTextRange& wxRichTextLine::GetRange ( )
inline

Returns the range.

virtual wxRect wxRichTextLine::GetRect ( ) const
inlinevirtual

Returns the rectangle enclosing the line.

virtual wxSize wxRichTextLine::GetSize ( ) const
inlinevirtual

Returns the line size as calculated by Layout.

void wxRichTextLine::Init ( wxRichTextParagraph parent)

Initialises the object.

void wxRichTextLine::SetDescent ( int  descent)
inline

Sets the stored descent.

virtual void wxRichTextLine::SetPosition ( const wxPoint pos)
inlinevirtual

Sets the object position relative to the parent.

void wxRichTextLine::SetRange ( const wxRichTextRange range)
inline

Sets the range associated with this line.

void wxRichTextLine::SetRange ( long  from,
long  to 
)
inline

Sets the range associated with this line.

virtual void wxRichTextLine::SetSize ( const wxSize sz)
inlinevirtual

Sets the line size as calculated by Layout.

Member Data Documentation

int wxRichTextLine::m_descent
protected
wxRichTextParagraph* wxRichTextLine::m_parent
protected
wxPoint wxRichTextLine::m_pos
protected
wxRichTextRange wxRichTextLine::m_range
protected
wxSize wxRichTextLine::m_size
protected