KImageIO

KImageIO Namespace Reference

Enumerations

enum  Mode { Reading, Writing }
 

Functions

bool isSupported (const QString &mimeType, Mode mode=Writing)
 
QStringList mimeTypes (Mode mode=Writing)
 
QString pattern (Mode mode=Reading)
 
QStringList typeForMime (const QString &mimeType)
 
QStringList types (Mode mode=Writing)
 

Detailed Description

Methods to get information about image format names and the corresponding mime type.

Also, you can get information about supported image types without loading all the imageformat plugins.

The image processing backends are written as image handlers compatible with the QImageIOHandler format. The backends are Qt imageformat plugins. Each format can be identified by a unique type id string.

Formats:

Currently supported formats include:

  • BMP <read> <write>
  • EPS <read> <write>
  • EXR <read>
  • G3 <read>
  • GIF <read>
  • ICO <read>
  • JP2 <read> <write>
  • JPEG <read> <write>
  • NETPBM <read> <write>
  • PCX <read> <write>
  • PNG <read> <write, only with newer libraries>
  • TGA <read> <write>
  • TIFF <read>
  • XBM <read> <write>
  • XPM <read> <write>
  • XV <read> <write>

Enumeration Type Documentation

◆ Mode

Possible image file access modes.

Used in various KImageIO static function.

Definition at line 53 of file kimageio.h.

Function Documentation

◆ isSupported()

bool KImageIO::isSupported ( const QString mimeType,
Mode  mode = Writing 
)

Test to see whether a MIME type is supported to reading/writing.

Parameters
_mimeTypethe MIME type to check
_modeTells whether to check for reading or writing capabilities
Returns
true if the type is supported
Deprecated:
since 5.0, use QImageReader/QImageWriter::supportedMimeTypes() instead.

Definition at line 102 of file kimageio.cpp.

◆ mimeTypes()

QStringList KImageIO::mimeTypes ( Mode  mode = Writing)

Returns a list of MIME types for all KImageIO supported formats.

Parameters
modeTells whether to retrieve modes that can be read or written.
Returns
a list if MIME types of the supported formats
Deprecated:
since 5.0, use QImageReader/QImageWriter::supportedMimeTypes() instead.

Definition at line 69 of file kimageio.cpp.

◆ pattern()

QString KImageIO::pattern ( Mode  mode = Reading)

Returns a list of patterns of all KImageIO supported formats.

kimgio.h – Implementation of interface to the KDE Image IO library.

These patterns can be passed to KFileDialog::getOpenFileName() or KFileDialog::getSaveFileName(), for example.

Parameters
modeTells whether to retrieve modes that can be read or written.
Returns
a space-separated list of file globs that describe the supported formats
Deprecated:
since 5.0, use QIMageReader/QImageWriter::supportedMimeTypes() and QFileDialog::setMimeTypeFilters() instead.

Copyright (c) 1998 Sirtaj Singh Kang [email protected][email protected]de.o[email protected]rg

This library is distributed under the conditions of the GNU LGPL.

Definition at line 16 of file kimageio.cpp.

◆ typeForMime()

QStringList KImageIO::typeForMime ( const QString mimeType)

Returns the type of a MIME type.

Parameters
mimeTypethe MIME type to search
Returns
type id(s) of the MIME type or QStringList() if the MIME type is not supported
Deprecated:
since 5.0, use QMimeType::suffixes() instead().

Definition at line 54 of file kimageio.cpp.

◆ types()

QStringList KImageIO::types ( Mode  mode = Writing)

Returns a list of all KImageIO supported formats.

Parameters
modeTells whether to retrieve modes that can be read or written.
Returns
a list of the type ids
Deprecated:
since 5.0, use QImageReader/QImageWriter::supportedImageFormats() instead.

Definition at line 88 of file kimageio.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 03:56:01 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.