Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members
Accessibility::StreamableContent

Accessibility::StreamableContent Interface Reference

An interface whereby an object allows its backing content to be streamed to clients. More...

import "Accessibility_StreamableContent.idl";

List of all members.

Public Types

enum  SeekType {
  SEEK_SET,
  SEEK_CURRENT,
  SEEK_END
}
 Specifies the meaning of a seek 'offset'. More...

Public Member Functions

StringSeq getContentTypes ()
 getContentTypes:
Bonobo::Stream getContent (in string contentType)
 
DEPRECATED, use getStream instead.
Stream getStream (in string contentType)
 Retrieve this object's content, in a format appropriate to a requested mimetype, as a StreamableContent::Stream instance.

Classes

exception  IOError
 Indicates that a transmission error has occurred while reading or seeking the stream or data source. More...
exception  NoPermission
 The operation is supported, but the current requestor does not have permission to t the request, for instance does not have permission to read the stream. More...
exception  NotSupported
 Indicates that the requested operation is not supported by the stream instance. More...
interface  Stream
 An interface by which the requested data from a StreamableContent object may be read by the client. More...

Detailed Description

An interface whereby an object allows its backing content to be streamed to clients.

Negotiation of content type is allowed. Clients may examine the backing data and transform, convert, or parse the content in order to present it in an alternate form to end-users.

Note:
The StreamableContent interface is particularly useful for saving, printing, or post-processing entire documents, or for persisting alternate views of a document. If document content itself is being serialized, stored, or converted, then use of the StreamableContent interface can help address performance issues. Unlike most AT-SPI/Accessibility interfaces, this interface is not strongly tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data.

Definition at line 46 of file Accessibility_StreamableContent.idl.

Member Enumeration Documentation

enum Accessibility::StreamableContent::SeekType
 

Specifies the meaning of a seek 'offset'.

Not all SeekTypes are supported by all StreamableContent data sources, for instance some streams may not support seeking from the beginning or other types of 'backwards' seeks.

Enumerator:
SEEK_SET  Seek from the start of the stream or data source.
SEEK_CURRENT  Seek relative to the current position.
SEEK_END  Seek from the end of the file, stream, or data source.

Definition at line 54 of file Accessibility_StreamableContent.idl.

Member Function Documentation

StringSeq Accessibility::StreamableContent::getContentTypes (   ) 
 

getContentTypes:

Returns:
the list of available mimetypes for this object's content.

Bonobo::Stream Accessibility::StreamableContent::getContent (  in string  contentType  ) 
 


DEPRECATED, use getStream instead.

getContent: Retrieve this object's content, in a format appropriate to a requested mimetype.

Note:
the data is returned as an object of type Bonobo::Stream. The primary methods which are supported on Bonobo::Streams for the purposes of the StreamableContent API are seek and read. seek may not be supported for all mimetypes or all implementors.
        long Bonobo::Stream:seek (in long offset, in SeekType whence)
                raises (NoPermission, IOError)
        void Bonobo::Stream:read (in long count, out iobuf buffer)
                raises (NoPermission, IOError)

See also:
Bonobo::Stream
Returns:
a Bonobo::Stream whose mimetype matches contentType, if available, or NIL.

Stream Accessibility::StreamableContent::getStream (  in string  contentType  ) 
 

Retrieve this object's content, in a format appropriate to a requested mimetype, as a StreamableContent::Stream instance.

Note:
This method supercedes the older getContent method, which relied on the Bonobo::Stream API. seek may not be supported for all mimetypes or all implementors.
Parameters:
contentType a string specifying the desired mimetype for the content stream.
Returns:
a Stream whose mimetype matches contentType, if available, or NIL.
Since:
AT-SPI 1.7.0

The documentation for this interface was generated from the following file:
Generated on Fri Dec 2 15:20:47 2005 for AT_SPI_IDL by  doxygen 1.4.3