Namespace Sxp
Class ILocator

class ILocator: public CInterface {
public:
    virtual ~ILocator();
public:
    virtual CString GetPublicId() = 0;
    virtual CString GetSystemId() = 0;
    virtual int GetColumnNumber() = 0;
    virtual int GetLineNumber() = 0;
    };

The abstract interface for associating an SXP event with a document location.

If an SXP parser provides location information to the SXP application, it does so by implementing this interface and then passing an instance to the application using the document handler's IDocumentHandler::SetDocumentLocator method. The application can use the object to obtain the location of any other document handler event in the XML source document.

Since:

1.00.00

Version:

1.00.00

Author:

Alexey Gokhberg

~ILocator

virtual ~ILocator();

Destroys the locator.

GetPublicId

virtual CString GetPublicId() = 0;

Gets the public identifier for the current document event.

Returns:

a string containing the public identifier, or the empty string if none is available

GetSystemId

virtual CString GetSystemId() = 0;

Gets the system identifier for the current document event.

Returns:

a string containing the system identifier, or the empty string if none is available

GetColumnNumber

virtual int GetColumnNumber() = 0;

Gets the line number where the current document event ends.

Returns:

the line number, of -1 if none is available

GetLineNumber

virtual int GetLineNumber() = 0;

Gets the column number where the current document event ends.

Returns:

the column number, of -1 if none is available