Main Page   Namespace List   Class Hierarchy   Data Structures   File List   Namespace Members   Data Fields  

Accessibility::StreamableContent Interface Reference

import "Accessibility_StreamableContent.idl";


Public Types

enum  SeekType { SEEK_SET, SEEK_CURRENT, SEEK_END }

Public Methods

StringSeq getContentTypes ()
Bonobo::Stream getContent (in string contentType)
void unImplemented ()
void unImplemented2 ()
void unImplemented3 ()
void unImplemented4 ()


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.


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.

Enumeration values:
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.


Member Function Documentation

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

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.

StringSeq Accessibility::StreamableContent::getContentTypes  
 

getContentTypes:

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

void Accessibility::StreamableContent::unImplemented  
 

\cond unImplemented:

placeholders for future expansion.

void Accessibility::StreamableContent::unImplemented2  
 

void Accessibility::StreamableContent::unImplemented3  
 

void Accessibility::StreamableContent::unImplemented4  
 


The documentation for this interface was generated from the following file:
Generated on Thu Mar 23 17:40:30 2006 for at-spi-idl by doxygen1.2.17