From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qimageio.html | 372 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 372 insertions(+) create mode 100644 doc/html/qimageio.html (limited to 'doc/html/qimageio.html') diff --git a/doc/html/qimageio.html b/doc/html/qimageio.html new file mode 100644 index 000000000..52e2ad685 --- /dev/null +++ b/doc/html/qimageio.html @@ -0,0 +1,372 @@ + + + + + +TQImageIO Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQImageIO Class Reference

+ +

The TQImageIO class contains parameters for loading and +saving images. +More... +

#include <qimage.h> +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Detailed Description

+ + +

The TQImageIO class contains parameters for loading and +saving images. +

+ + +

TQImageIO contains a TQIODevice object that is used for image data +I/O. The programmer can install new image file formats in addition +to those that TQt provides. +

TQt currently supports the following image file formats: PNG, BMP, +XBM, XPM and PNM. It may also support JPEG, MNG and GIF, if +specially configured during compilation. The different PNM formats +are: PBM (P1 or P4), PGM (P2 or P5), and PPM (P3 or P6). +

You don't normally need to use this class; TQPixmap::load(), +TQPixmap::save(), and TQImage contain sufficient functionality. +

For image files that contain sequences of images, only the first +is read. See TQMovie for loading multiple images. +

PBM, PGM, and PPM format output is always in the more condensed +raw format. PPM and PGM files with more than 256 levels of +intensity are scaled down when reading. +

Warning: If you are in a country which recognizes software patents +and in which Unisys holds a patent on LZW compression and/or +decompression and you want to use GIF, Unisys may retquire you to +license the technology. Such countries include Canada, Japan, the +USA, France, Germany, Italy and the UK. +

GIF support may be removed completely in a future version of TQt. +We recommend using the PNG format. +

See also TQImage, TQPixmap, TQFile, TQMovie, Graphics Classes, Image Processing Classes, and Input/Output and Networking. + +

Member Function Documentation

+

TQImageIO::TQImageIO () +

+Constructs a TQImageIO object with all parameters set to zero. + +

TQImageIO::TQImageIO ( TQIODevice * ioDevice, const char * format ) +

+Constructs a TQImageIO object with the I/O device ioDevice and a +format tag. + +

TQImageIO::TQImageIO ( const TQString & fileName, const char * format ) +

+Constructs a TQImageIO object with the file name fileName and a +format tag. + +

TQImageIO::~TQImageIO () +

+Destroys the object and all related data. + +

void TQImageIO::defineIOHandler ( const char * format, const char * header, const char * flags, image_io_handler readImage, image_io_handler writeImage ) [static] +

+Defines an image I/O handler for the image format called format, which is recognized using the regular expression header, read using readImage and +written using writeImage. +

flags is a string of single-character flags for this format. +The only flag defined currently is T (upper case), so the only +legal value for flags are "T" and the empty string. The "T" +flag means that the image file is a text file, and TQt should treat +all newline conventions as equivalent. (XPM files and some PPM +files are text files for example.) +

format is used to select a handler to write a TQImage; header +is used to select a handler to read an image file. +

If readImage is a null pointer, the TQImageIO will not be able +to read images in format. If writeImage is a null pointer, +the TQImageIO will not be able to write images in format. If +both are null, the TQImageIO object is valid but useless. +

Example: +

+        void readGIF( TQImageIO *image )
+        {
+        // read the image using the image->ioDevice()
+        }
+
+        void writeGIF( TQImageIO *image )
+        {
+        // write the image using the image->ioDevice()
+        }
+
+        // add the GIF image handler
+
+        TQImageIO::defineIOHandler( "GIF",
+                                   "^GIF[0-9][0-9][a-z]",
+                                   0,
+                                   readGIF,
+                                   writeGIF );
+
+ +

Before the regex test, all the 0 bytes in the file header are +converted to 1 bytes. This is done because when TQt was +ASCII-based, TQRegExp could not handle 0 bytes in strings. +

The regexp is only applied on the first 14 bytes of the file. +

Note that TQt assumes that there is only one handler per format; if +two handlers support the same format, TQt will choose one +arbitrarily. It is not possible to have one handler support +reading, and another support writing. + +

TQString TQImageIO::description () const +

+ +

Returns the image description string. +

See also setDescription(). + +

TQString TQImageIO::fileName () const +

+ +

Returns the file name currently set. +

See also setFileName(). + +

const char * TQImageIO::format () const +

+ +

Returns the image format string or 0 if no format has been +explicitly set. + +

float TQImageIO::gamma () const +

+Returns the gamma value at which the image will be viewed. +

See also setGamma(). + +

const TQImage & TQImageIO::image () const +

+ +

Returns the image currently set. +

See also setImage(). + +

const char * TQImageIO::imageFormat ( const TQString & fileName ) [static] +

+Returns a string that specifies the image format of the file fileName, or null if the file cannot be read or if the format is +not recognized. + +

const char * TQImageIO::imageFormat ( TQIODevice * d ) [static] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Returns a string that specifies the image format of the image read +from IO device d, or 0 if the device cannot be read or if the +format is not recognized. +

Make sure that d is at the right position in the device (for +example, at the beginning of the file). +

See also TQIODevice::at(). + +

TQStrList TQImageIO::inputFormats () [static] +

+Returns a sorted list of image formats that are supported for +image input. + +

TQIODevice * TQImageIO::ioDevice () const +

+ +

Returns the IO device currently set. +

See also setIODevice(). + +

TQStrList TQImageIO::outputFormats () [static] +

+Returns a sorted list of image formats that are supported for +image output. + +

Example: scribble/scribble.cpp. +

const char * TQImageIO::parameters () const +

+Returns the image's parameters string. +

See also setParameters(). + +

int TQImageIO::quality () const +

+Returns the quality of the written image, related to the +compression ratio. +

See also setQuality() and TQImage::save(). + +

bool TQImageIO::read () +

+Reads an image into memory and returns TRUE if the image was +successfully read; otherwise returns FALSE. +

Before reading an image you must set an IO device or a file name. +If both an IO device and a file name have been set, the IO device +will be used. +

Setting the image file format string is optional. +

Note that this function does not set the format used to read the image. If you need that +information, use the imageFormat() static functions. +

Example: +

+        TQImageIO iio;
+        TQPixmap  pixmap;
+        iio.setFileName( "vegeburger.bmp" );
+        if ( image.read() )        // ok
+            pixmap = iio.image();  // convert to pixmap
+
+ +

See also setIODevice(), setFileName(), setFormat(), write(), and TQPixmap::load(). + +

void TQImageIO::setDescription ( const TQString & description ) +

+Sets the image description string for image handlers that support +image descriptions to description. +

Currently, no image format supported by TQt uses the description +string. + +

void TQImageIO::setFileName ( const TQString & fileName ) +

+Sets the name of the file to read or write an image from to fileName. +

See also setIODevice(). + +

void TQImageIO::setFormat ( const char * format ) +

+Sets the image format to format for the image to be read or +written. +

It is necessary to specify a format before writing an image, but +it is not necessary to specify a format before reading an image. +

If no format has been set, TQt guesses the image format before +reading it. If a format is set the image will only be read if it +has that format. +

See also read(), write(), and format(). + +

void TQImageIO::setGamma ( float gamma ) +

+Sets the gamma value at which the image will be viewed to gamma. If the image format stores a gamma value for which the +image is intended to be used, then this setting will be used to +modify the image. Setting to 0.0 will disable gamma correction +(i.e. any specification in the file will be ignored). +

The default value is 0.0. +

See also gamma(). + +

void TQImageIO::setIODevice ( TQIODevice * ioDevice ) +

+Sets the IO device to be used for reading or writing an image. +

Setting the IO device allows images to be read/written to any +block-oriented TQIODevice. +

If ioDevice is not null, this IO device will override file name +settings. +

See also setFileName(). + +

void TQImageIO::setImage ( const TQImage & image ) +

+Sets the image to image. +

See also image(). + +

void TQImageIO::setParameters ( const char * parameters ) +

+Sets the image's parameter string to parameters. This is for +image handlers that retquire special parameters. +

Although the current image formats supported by TQt ignore the +parameters string, it may be used in future extensions or by +contributions (for example, JPEG). +

See also parameters(). + +

void TQImageIO::setQuality ( int q ) +

+Sets the quality of the written image to q, related to the +compression ratio. +

q must be in the range -1..100. Specify 0 to obtain small +compressed files, 100 for large uncompressed files. (-1 signifies +the default compression.) +

See also quality() and TQImage::save(). + +

void TQImageIO::setStatus ( int status ) +

+Sets the image IO status to status. A non-zero value indicates +an error, whereas 0 means that the IO operation was successful. +

See also status(). + +

int TQImageIO::status () const +

+ +

Returns the image's IO status. A non-zero value indicates an +error, whereas 0 means that the IO operation was successful. +

See also setStatus(). + +

bool TQImageIO::write () +

+Writes an image to an IO device and returns TRUE if the image was +successfully written; otherwise returns FALSE. +

Before writing an image you must set an IO device or a file name. +If both an IO device and a file name have been set, the IO device +will be used. +

The image will be written using the specified image format. +

Example: +

+        TQImageIO iio;
+        TQImage   im;
+        im = pixmap; // convert to image
+        iio.setImage( im );
+        iio.setFileName( "vegeburger.bmp" );
+        iio.setFormat( "BMP" );
+        if ( iio.write() )
+            // returned TRUE if written successfully
+
+ +

See also setIODevice(), setFileName(), setFormat(), read(), and TQPixmap::save(). + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1