struct CCL::ITextStreamer

Overview

#include <itextstreamer.h>

struct ITextStreamer: public CCL::IUnknown
{
    // enums

    enum Options;

    // methods

    virtual TextEncoding CCL_API getTextEncoding () const = 0;
    virtual TextLineFormat CCL_API getLineFormat () const = 0;
    virtual tbool CCL_API isEndOfStream () const = 0;
    virtual tbool CCL_API readChar (uchar& c) = 0;
    virtual tbool CCL_API readLine (String& string) = 0;
    virtual tbool CCL_API writeChar (uchar c) = 0;

    virtual tbool CCL_API writeString (
        StringRef string,
        tbool appendNewline = false
    ) = 0;

    virtual tbool CCL_API writeNewline () = 0;
    ITextStreamer tbool writeLine (StringRef string);
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Methods

virtual TextEncoding CCL_API getTextEncoding () const = 0

Returns current text encoding.

virtual TextLineFormat CCL_API getLineFormat () const = 0

Returns current line format.

virtual tbool CCL_API isEndOfStream () const = 0

Check if end of stream is reached.

virtual tbool CCL_API readChar (uchar& c) = 0

Read a single UTF-16 character.

virtual tbool CCL_API readLine (String& string) = 0

Read a whole line.

virtual tbool CCL_API writeChar (uchar c) = 0

Write a single UTF-16 character.

virtual tbool CCL_API writeString (
    StringRef string,
    tbool appendNewline = false
) = 0

Write a whole UTF-16 string with optional newline sequence.

virtual tbool CCL_API writeNewline () = 0

Write a newline sequence, depending on line format.