QMimeSourceFactory

NAME

SYNOPSIS

Public Members

Static Public Members

DESCRIPTION

A QMimeSourceFactory provides an abstract interface to a collection of information. Each piece of information is represented by a QMimeSource object which can be examined and converted to concrete data types by functions such as QImageDrag::canDecode() and QImageDrag::decode().

The base QMimeSourceFactory can be used in two ways: as an abstraction of a collection of files or as specifically stored data. For it to access files, call setFilePath() before accessing data. For stored data, call setData() for each item (there are also convenience functions, e.g. setText(), setImage() and setPixmap(), that simply call setData() with appropriate parameters).

The rich text widgets, QTextEdit and QTextBrowser, use QMimeSourceFactory to resolve references such as images or links within rich text documents. They either access the default factory (see defaultFactory()) or their own (see QTextEdit::setMimeSourceFactory()). Other classes that are capable of displaying rich text (such as QLabel, QWhatsThis or QMessageBox) always use the default factory.

A factory can also be used as a container to store data associated with a name. This technique is useful whenever rich text contains images that are stored in the program itself, not loaded from the hard disk. Your program may, for example, define some image data as:

    static const char* myimage_data[]={


    "...",


    ...


    "..."};

To be able to use this image within some rich text, for example inside a QLabel, you must create a QImage from the raw data and insert it into the factory with a unique name:

    QMimeSourceFactory::defaultFactory()->setImage( "myimage", QImage(myimage_data) );

Now you can create a rich text QLabel with

    QLabel* label = new QLabel(


        "Rich text with embedded image:<img source=\"myimage\">"


        "Isn't that <em>cute</em>?" );

When no longer needed, you can clear the data from the factory:

    delete label;


    QMimeSourceFactory::defaultFactory()->setData( "myimage", 0 );

See also Environment Classes and Input/Output and Networking.  

MEMBER FUNCTION DOCUMENTATION

QMimeSourceFactory::QMimeSourceFactory ()

QMimeSourceFactory::~QMimeSourceFactory () [virtual]

void QMimeSourceFactory::addFactory ( QMimeSourceFactory * f ) [static]

See also removeFactory().  

void QMimeSourceFactory::addFilePath ( const QString & p )

See also setFilePath().  

const QMimeSource * QMimeSourceFactory::data ( const QString & abs_name ) const [virtual]

If there is no data associated with abs_name in the factory's store, the factory tries to access the local filesystem. If abs_name isn't an absolute file name, the factory will search for it in all defined paths (see setFilePath()).

The factory understands all the image formats supported by QImageIO. Any other mime types are determined by the file name extension. The default settings are

    setExtensionType("html", "text/html;charset=iso8859-1");


    setExtensionType("htm", "text/html;charset=iso8859-1");


    setExtensionType("txt", "text/plain");


    setExtensionType("xml", "text/xml;charset=UTF-8");

Any file data that is not recognized will be retrieved as a QMimeSource providing the "application/octet-stream" mime type, meaning uninterpreted binary data.

You can add further extensions or change existing ones with subsequent calls to setExtensionType(). If the extension mechanism is not sufficient for your problem domain, you can inherit QMimeSourceFactory and reimplement this function to perform some more specialized mime-type detection. The same applies if you want to use the mime source factory to access URL referenced data over a network.  

const QMimeSource * QMimeSourceFactory::data ( const QString & abs_or_rel_name, const QString & context ) const

A convenience function. See data(const QString& abs_name). The file name is given in abs_or_rel_name and the path is in context.  

QMimeSourceFactory * QMimeSourceFactory::defaultFactory () [static]

See also setDefaultFactory().

Examples:  

QStringList QMimeSourceFactory::filePath () const [virtual]

QString QMimeSourceFactory::makeAbsolute ( const QString & abs_or_rel_name, const QString & context ) const [virtual]

void QMimeSourceFactory::removeFactory ( QMimeSourceFactory * f ) [static]

See also addFactory().  

void QMimeSourceFactory::setData ( const QString & abs_name, QMimeSource * data ) [virtual]

Passing 0 for data removes previously stored data.  

void QMimeSourceFactory::setDefaultFactory ( QMimeSourceFactory * factory ) [static]

See also defaultFactory().  

void QMimeSourceFactory::setExtensionType ( const QString & ext, const char * mimetype ) [virtual]

void QMimeSourceFactory::setFilePath ( const QStringList & path ) [virtual]

See also filePath().  

void QMimeSourceFactory::setImage ( const QString & abs_name, const QImage & image ) [virtual]

Equivalent to setData(abs_name, new QImageDrag(image)).  

void QMimeSourceFactory::setPixmap ( const QString & abs_name, const QPixmap & pixmap ) [virtual]

void QMimeSourceFactory::setText ( const QString & abs_name, const QString & text ) [virtual]

Equivalent to setData(abs_name, new QTextDrag(text)).  

QMimeSourceFactory * QMimeSourceFactory::takeDefaultFactory () [static]

SEE ALSO

COPYRIGHT

AUTHOR

BUGS