summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qimageformattype.3qt
blob: 7b60a82ff3f06f97995cb06f4aab0ddd04d924c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
'\" t
.TH QImageFormatType 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QImageFormatType \- Factory that makes QImageFormat objects
.SH SYNOPSIS
\fC#include <qasyncimageio.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "virtual \fB~QImageFormatType\fR ()"
.br
.ti -1c
.BI "virtual QImageFormat * \fBdecoderFor\fR ( const uchar * buffer, int length ) = 0"
.br
.ti -1c
.BI "virtual const char * \fBformatName\fR () const = 0"
.br
.in -1c
.SS "Protected Members"
.in +1c
.ti -1c
.BI "\fBQImageFormatType\fR ()"
.br
.in -1c
.SH DESCRIPTION
The QImageFormatType class is a factory that makes QImageFormat objects.
.PP
Whereas the QImageIO class allows for \fIcomplete\fR loading of images, QImageFormatType allows for \fIincremental\fR loading of images.
.PP
New image file formats are installed by creating objects of derived classes of QImageFormatType. They must implement decoderFor() and formatName().
.PP
QImageFormatType is a very simple class. Its only task is to recognize image data in some format and make a new object, subclassed from QImageFormat, which can decode that format.
.PP
The factories for formats built into Qt are automatically defined before any other factory is initialized. If two factories would recognize an image format, the factory created last will override the earlier one; you can thus override current and future built-in formats.
.PP
See also Graphics Classes, Image Processing Classes, and Multimedia Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QImageFormatType::QImageFormatType ()\fC [protected]\fR"
Constructs a factory. It automatically registers itself with QImageDecoder.
.SH "QImageFormatType::~QImageFormatType ()\fC [virtual]\fR"
Destroys a factory. It automatically unregisters itself from QImageDecoder.
.SH "QImageFormat * QImageFormatType::decoderFor ( const uchar * buffer, int length )\fC [pure virtual]\fR"
Returns a decoder for decoding an image that starts with the bytes in \fIbuffer\fR. The length of the data is given in \fIlength\fR. This function should only return a decoder if it is certain that the decoder applies to data with the given header. Returns 0 if there is insufficient data in the header to make a positive identification or if the data is not recognized.
.SH "const char * QImageFormatType::formatName () const\fC [pure virtual]\fR"
Returns the name of the format supported by decoders from this
factory. The string is statically allocated.

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qimageformattype.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (qimageformattype.3qt) and the Qt
version (3.3.8).