Index

DKMatchesTextItemTS

Purpose:

The DKMatchesTextItemTS class provides the interface for a document text item.

Class summary:

    class DKMatchesTextItemTS : public dkDataObjectBase
    {
   public:
     ...
     DKMatchesTextItemTS();
     virtual ~DKMatchesTextItemTS();
     short protocol();
     DKString getObjectType();
     DKString getText();
     void setText(const char* text);
     DKBoolean isMatch();
     long numberOfNewLines();
     void addNewLine();
     long getOffset();
     void setOffset(long offset);
     long getLength();
     void setLength(long length); 
    }
 

Members:

Constructors and destructor
     DKMatchesTextItemTS();
     virtual ~DKMatchesTextItemTS();

Member functions

protocol
Gets the protocol type associated with this data object.
     short protocol();
 

getObjectType
Gets the type of this object.
     DKString getObjectType();
 

getText
Gets the document text.
     DKString getText();
 

setText
Sets the document text.
     void setText(const char* text);
 

isMatch
Returns the value TRUE if this text contains a match.
     DKBoolean isMatch();
 

numberOfNewLines
Get the number of new lines in the text.
     long numberOfNewLines();
 

addNewLine
Adds a new line to this text.
     void addNewLine();
 

getOffset
Gets the match offset in the text string.
     long getOffset();
 

setOffset
Sets the match offset in the text string.
     void setOffset(long offset);
 

getLength
Gets the match length in the text string.
     long getLength();
 

setLength
Sets the match length in the text string.
     void setLength(long length); 
 

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.