Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::TextEvent Class Reference

#include <vcf/ApplicationKit/TextEvent.h>

Inheritance diagram for VCF::TextEvent:

VCF::ModelEvent VCF::Event VCF::Object List of all members.

Public Member Functions

 TextEvent (Object *source)
 TextEvent (Object *source, const String &changedText)
 TextEvent (Object *source, int selectionStart, uint32 selectionLength)
 TextEvent (Object *source, uint32 type, const String &changedText, uint32 changeStart, uint32 changeLength)
 TextEvent (Object *source, uint32 type, const String &replacedText, const String &changedText, uint32 replaceStart, uint32 replaceLength)
 TextEvent (const TextEvent &rhs)
virtual ~TextEvent ()
TextEventoperator= (const TextEvent &rhs)
String getChangeText ()
String getOriginalText ()
TextModelgetTextModel ()
 returns the text model associated with this event.
virtual Objectclone (bool deep=false)
 Makes a complete clone of this object.
int getSelectionStart () const
 Returns the current position of the selection.
uint32 getSelectionLength () const
 Returns the number of characters in the selection.
uint32 getChangeStart () const
 returns the start of the change
uint32 getChangeLength () const
 returns the length of the change

Constructor & Destructor Documentation

VCF::TextEvent::TextEvent Object source  )  [inline]
 

VCF::TextEvent::TextEvent Object source,
const String changedText
[inline]
 

VCF::TextEvent::TextEvent Object source,
int  selectionStart,
uint32  selectionLength
[inline]
 

VCF::TextEvent::TextEvent Object source,
uint32  type,
const String changedText,
uint32  changeStart,
uint32  changeLength
[inline]
 

VCF::TextEvent::TextEvent Object source,
uint32  type,
const String replacedText,
const String changedText,
uint32  replaceStart,
uint32  replaceLength
[inline]
 

VCF::TextEvent::TextEvent const TextEvent rhs  )  [inline]
 

virtual VCF::TextEvent::~TextEvent  )  [inline, virtual]
 


Member Function Documentation

virtual Object* VCF::TextEvent::clone bool  deep = false  )  [inline, virtual]
 

Makes a complete clone of this object.

A typical implementation might be:

    virtual Object* clone( bool deep ) {
        return new MyObject( this );
    }
In which the implementer simply creates a new instance on the heap and calls the copy constructor. Objects which support cloning should also have a copy constructor defined as well.

Parameters:
bool deep if deep is true then any object instances that this object owns should probably be cloned as well, with full new copies made. Otherwise it would be acceptable to simply copy the pointer values. The default value is for deep cloning to be false.
Returns:
Object a new instance that should be an copy of this. If the object doesn't support cloning the return will value will be NULL.

Reimplemented from VCF::ModelEvent.

uint32 VCF::TextEvent::getChangeLength  )  const [inline]
 

returns the length of the change

uint32 VCF::TextEvent::getChangeStart  )  const [inline]
 

returns the start of the change

String VCF::TextEvent::getChangeText  )  [inline]
 

String VCF::TextEvent::getOriginalText  )  [inline]
 

uint32 VCF::TextEvent::getSelectionLength  )  const [inline]
 

Returns the number of characters in the selection.

int VCF::TextEvent::getSelectionStart  )  const [inline]
 

Returns the current position of the selection.

A return value of -1 indicates no current selection. In this case the getSelectionLength() will also return 0.

TextModel* VCF::TextEvent::getTextModel  )  [inline]
 

returns the text model associated with this event.

May return null if the source of the event was not a TextModel

TextEvent& VCF::TextEvent::operator= const TextEvent rhs  )  [inline]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information