.TH "KImageIO" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KImageIO \- Interface to the \fBKDE\fP Image IO plugin architecture.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kimageio.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMode\fP { \fBReading\fP, \fBWriting\fP }"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBregisterFormats\fP ()"
.br
.ti -1c
.RI "static bool \fBcanWrite\fP (const \fBQString\fP &type)"
.br
.ti -1c
.RI "static bool \fBcanRead\fP (const \fBQString\fP &type)"
.br
.ti -1c
.RI "static \fBQStringList\fP \fBtypes\fP (\fBMode\fP mode=Writing)"
.br
.ti -1c
.RI "static \fBQString\fP \fBpattern\fP (\fBMode\fP mode=Reading)"
.br
.ti -1c
.RI "static \fBQString\fP \fBsuffix\fP (const \fBQString\fP &type)"
.br
.ti -1c
.RI "static \fBQString\fP \fBtypeForMime\fP (const \fBQString\fP &mimeType)"
.br
.ti -1c
.RI "static \fBQString\fP \fBtype\fP (const \fBQString\fP &filename)"
.br
.ti -1c
.RI "static \fBQStringList\fP \fBmimeTypes\fP (\fBMode\fP mode=Writing)"
.br
.ti -1c
.RI "static bool \fBisSupported\fP (const \fBQString\fP &_mimeType, \fBMode\fP _mode=Writing)"
.br
.ti -1c
.RI "static \fBQString\fP \fBmimeType\fP (const \fBQString\fP &_filename)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Interface to the \fBKDE\fP Image IO plugin architecture. 

This library allows \fBKDE\fP applications to read and write images in a variety of formats, transparently via the \fBQImage\fP and \fBQPixmap\fP load and save methods.
.PP
The image processing backends are written as image handlers compatible with the \fBQImageIO\fP handler format. The backends are loaded on demand when a particular format is requested. Each format can be identified by a unique type id string.
.PP
\fBFormats:\fP 
.PP
Currently supported formats include: 
.PD 0

.IP "\(bu" 2
BMP <read> <write> 
.IP "\(bu" 2
EPS <read> <write> 
.IP "\(bu" 2
EXR <read> 
.IP "\(bu" 2
G3 <read> 
.IP "\(bu" 2
GIF <read> 
.IP "\(bu" 2
ICO <read> 
.IP "\(bu" 2
JP2 <read> <write> 
.IP "\(bu" 2
JPEG <read> <write> 
.IP "\(bu" 2
NETPBM <read> <write> 
.IP "\(bu" 2
PCX <read> <write> 
.IP "\(bu" 2
PNG <read> <write, only with newer libraries> 
.IP "\(bu" 2
TGA <read> <write> 
.IP "\(bu" 2
TIFF <read> 
.IP "\(bu" 2
XBM <read> <write> 
.IP "\(bu" 2
XPM <read> <write> 
.IP "\(bu" 2
XV <read> <write>
.PP
\fBUsage:\fP 
.PP
Simply call the \fBKImageIO::registerFormats()\fP static method declared in \fBkimageio.h\fP.
.PP
\fBExample:\fP 
.PP
.PP
.nf
  #include<qpixmap.h>
  #include<kimgio.h>

  int main( int argc, char **argv )
  {
    ....
    KImageIO::registerFormats();
    ...   // start main program
  }
.fi
.PP
.PP
\fBSee also:\fP
.RS 4
KImageIO, \fBQPixmap\fP, \fBQImage\fP, \fBQImageIO\fP 
.RE
.PP
\fBAuthor:\fP
.RS 4
Sirtaj Singh Kang 
.RE
.PP

.PP
Definition at line 69 of file kimageio.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKImageIO::Mode\fP"
.PP
Possible image file access modes. 
.PP
Used in various KImageIO static function. 
.PP
Definition at line 77 of file kimageio.h.
.SH "Member Function Documentation"
.PP 
.SS "void KImageIO::registerFormats ()\fC [static]\fP"
.PP
Registers all KImageIO supported formats. 
.PP
Definition at line 378 of file kimageio.cpp.
.SS "bool KImageIO::canWrite (const \fBQString\fP & type)\fC [static]\fP"
.PP
Checks if a special type is supported for writing. 
.PP
\fBParameters:\fP
.RS 4
\fItype\fP the type id of the image type 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the image format can be written 
.RE
.PP

.PP
Definition at line 392 of file kimageio.cpp.
.PP
References type().
.SS "bool KImageIO::canRead (const \fBQString\fP & type)\fC [static]\fP"
.PP
Checks if a special type is supported for reading. 
.PP
\fBParameters:\fP
.RS 4
\fItype\fP the type id of the image type 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the image format can be read 
.RE
.PP

.PP
Definition at line 411 of file kimageio.cpp.
.PP
References type().
.SS "\fBQStringList\fP KImageIO::types (\fBMode\fP mode = \fCWriting\fP)\fC [static]\fP"
.PP
Returns a list of all KImageIO supported formats. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP Tells whether to retrieve modes that can be read or written. 
.RE
.PP
\fBReturns:\fP
.RS 4
a list of the type ids 
.RE
.PP

.PP
Definition at line 430 of file kimageio.cpp.
.PP
References types().
.PP
Referenced by types().
.SS "\fBQString\fP KImageIO::pattern (\fBMode\fP mode = \fCReading\fP)\fC [static]\fP"
.PP
Returns a list of patterns of all KImageIO supported formats. 
.PP
These patterns can be passed to \fBKFileDialog::getOpenFileName()\fP or \fBKFileDialog::getSaveFileName()\fP, for example.
.PP
\fBParameters:\fP
.RS 4
\fImode\fP Tells whether to retrieve modes that can be read or written. 
.RE
.PP
\fBReturns:\fP
.RS 4
a space-separated list of file globs that describe the supported formats 
.RE
.PP

.PP
Definition at line 384 of file kimageio.cpp.
.SS "\fBQString\fP KImageIO::suffix (const \fBQString\fP & type)\fC [static]\fP"
.PP
Returns the suffix of an image type. 
.PP
\fBParameters:\fP
.RS 4
\fItype\fP the type id of the file format 
.RE
.PP
\fBReturns:\fP
.RS 4
the suffix of the file format or QString::null if it does not exist 
.RE
.PP

.PP
Definition at line 450 of file kimageio.cpp.
.PP
References type().
.PP
Referenced by type().
.SS "\fBQString\fP KImageIO::typeForMime (const \fBQString\fP & mimeType)\fC [static]\fP"
.PP
Returns the type of a MIME type. 
.PP
\fBParameters:\fP
.RS 4
\fImimeType\fP the MIME type to search 
.RE
.PP
\fBReturns:\fP
.RS 4
type id of the MIME type or QString::null if the MIME type is not supported 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 469 of file kimageio.cpp.
.PP
References mimeType().
.SS "\fBQString\fP KImageIO::type (const \fBQString\fP & filename)\fC [static]\fP"
.PP
Returns the type of given filename. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the filename to check 
.RE
.PP
\fBReturns:\fP
.RS 4
if the file name's suffix is known the type id of the file type, otherwise QString::null 
.RE
.PP

.PP
Definition at line 488 of file kimageio.cpp.
.PP
References QString::findRev(), QString::mid(), and suffix().
.PP
Referenced by canRead(), canWrite(), and suffix().
.SS "\fBQStringList\fP KImageIO::mimeTypes (\fBMode\fP mode = \fCWriting\fP)\fC [static]\fP"
.PP
Returns a list of MIME types for all KImageIO supported formats. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP Tells whether to retrieve modes that can be read or written. 
.RE
.PP
\fBReturns:\fP
.RS 4
a list if MIME types of the supported formats 
.RE
.PP

.PP
Definition at line 511 of file kimageio.cpp.
.PP
Referenced by KFileDialog::getImageOpenURL().
.SS "bool KImageIO::isSupported (const \fBQString\fP & _mimeType, \fBMode\fP _mode = \fCWriting\fP)\fC [static]\fP"
.PP
\fBTest\fP to see whether a MIME type is supported to reading/writing. 
.PP
\fBParameters:\fP
.RS 4
\fI_mimeType\fP the MIME type to check 
.br
\fI_mode\fP Tells whether to check for reading or writing capabilities 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the type is supported 
.RE
.PP

.PP
Definition at line 533 of file kimageio.cpp.
.SS "\fBQString\fP KImageIO::mimeType (const \fBQString\fP & _filename)\fC [static]\fP"
.PP
Returns the MIME type of \fC_filename\fP. 
.PP
\fBParameters:\fP
.RS 4
\fI_filename\fP the filename to check 
.RE
.PP
\fBReturns:\fP
.RS 4
the MIME type of the file, or QString::null 
.RE
.PP

.PP
Definition at line 556 of file kimageio.cpp.
.PP
References KMimeType::findByURL().
.PP
Referenced by typeForMime().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
