com.trolltech.qt.gui
Class QPictureIO

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.gui.QPictureIO
All Implemented Interfaces:
QtJambiInterface

public class QPictureIO
extends QtJambiObject

The QPictureIO class contains parameters for loading and saving pictures. QPictureIO contains a QIODevice object that is used for picture data I/O. The programmer can install new picture file formats in addition to those that Qt provides.

You don't normally need to use this class; QPicture::load(), QPicture::save().

See also:
QPicture, QPixmap, and QFile.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QPictureIO()
          Constructs a QPictureIO object with all parameters set to zero.
QPictureIO(QIODevice ioDevice, java.lang.String format)
          Constructs a QPictureIO object with the I/O device ioDevice and a format tag.
QPictureIO(java.lang.String fileName, java.lang.String format)
          Constructs a QPictureIO object with the file name fileName and a format tag.
 
Method Summary
 java.lang.String description()
          Returns the picture description string.
 java.lang.String fileName()
          Returns the file name currently set.
 java.lang.String format()
          Returns the picture format string or null if no format has been explicitly set.
 float gamma()
          Returns the gamma value at which the picture will be viewed.
static java.util.List inputFormats()
          Returns a sorted list of picture formats that are supported for picture input.
 QIODevice ioDevice()
          Returns the IO device currently set.
static java.util.List outputFormats()
          Returns a sorted list of picture formats that are supported for picture output.
 java.lang.String parameters()
          Returns the picture's parameters string.
 QPicture picture()
          Returns the picture currently set.
static QByteArray pictureFormat(QIODevice arg__1)
          This is an overloaded member function, provided for convenience.
static QByteArray pictureFormat(java.lang.String fileName)
          Returns a string that specifies the picture format of the file fileName, or null if the file cannot be read or if the format is not recognized.
 int quality()
          Returns the quality of the written picture, related to the compression ratio.
 boolean read()
          Reads an picture into memory and returns true if the picture was successfully read; otherwise returns false.
 void setDescription(java.lang.String arg__1)
          Sets the picture description string for picture handlers that support picture descriptions to description.
 void setFileName(java.lang.String arg__1)
          Sets the name of the file to read or write an picture from to fileName.
 void setFormat(java.lang.String format)
          Sets the picture format to format for the picture to be read or written.
 void setGamma(float arg__1)
          Sets the gamma value at which the picture will be viewed to gamma.
 void setIODevice(QIODevice arg__1)
          Sets the IO device to be used for reading or writing an picture.
 void setParameters(java.lang.String parameters)
          Sets the picture's parameter string to parameters.
 void setPicture(QPicture arg__1)
          Sets the picture to picture.
 void setQuality(int arg__1)
          Sets the quality of the written picture to q, related to the compression ratio.
 void setStatus(int arg__1)
          Sets the picture IO status to status.
 int status()
          Returns the picture's IO status.
 boolean write()
          Writes an picture to an IO device and returns true if the picture was successfully written; otherwise returns false.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QPictureIO

public QPictureIO()
Constructs a QPictureIO object with all parameters set to zero.


QPictureIO

public QPictureIO(QIODevice ioDevice,
                  java.lang.String format)
Constructs a QPictureIO object with the I/O device ioDevice and a format tag.


QPictureIO

public QPictureIO(java.lang.String fileName,
                  java.lang.String format)
Constructs a QPictureIO object with the file name fileName and a format tag.

Method Detail

description

public final java.lang.String description()
Returns the picture description string.

See also:
setDescription().


fileName

public final java.lang.String fileName()
Returns the file name currently set.

See also:
setFileName().


gamma

public final float gamma()
Returns the gamma value at which the picture will be viewed.

See also:
setGamma().


ioDevice

public final QIODevice ioDevice()
Returns the IO device currently set.

See also:
setIODevice().


picture

public final QPicture picture()
Returns the picture currently set.

See also:
setPicture().


quality

public final int quality()
Returns the quality of the written picture, related to the compression ratio.

See also:
setQuality(), and QPicture::save().


read

public final boolean read()
Reads an picture into memory and returns true if the picture was successfully read; otherwise returns false.

Before reading an picture 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 picture file format string is optional.

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

Example:

            QPictureIO iio = new QPictureIO();
            QPixmap  pixmap = new QPixmap();
            iio.setFileName("vegeburger.pic");
            if (iio.read()) {        // OK
                QPicture picture = iio.picture();
                QPainter painter = new QPainter(pixmap);
                painter.drawPicture(0, 0, picture);
            }
    

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


setDescription

public final void setDescription(java.lang.String arg__1)
Sets the picture description string for picture handlers that support picture descriptions to description.

Currently, no picture format supported by Qt uses the description string.

See also:
description().


setFileName

public final void setFileName(java.lang.String arg__1)
Sets the name of the file to read or write an picture from to fileName.

See also:
fileName(), and setIODevice().


setGamma

public final void setGamma(float arg__1)
Sets the gamma value at which the picture will be viewed to gamma. If the picture format stores a gamma value for which the picture is intended to be used, then this setting will be used to modify the picture. 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().


setIODevice

public final void setIODevice(QIODevice arg__1)
Sets the IO device to be used for reading or writing an picture.

Setting the IO device allows pictures to be read/written to any block-oriented QIODevice.

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

See also:
setFileName().


setPicture

public final void setPicture(QPicture arg__1)
Sets the picture to picture.

See also:
picture().


setQuality

public final void setQuality(int arg__1)
Sets the quality of the written picture 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 QPicture::save().


setStatus

public final void setStatus(int arg__1)
Sets the picture IO status to status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful.

See also:
status().


status

public final int status()
Returns the picture's IO status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful.

See also:
setStatus().


write

public final boolean write()
Writes an picture to an IO device and returns true if the picture was successfully written; otherwise returns false.

Before writing an picture 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 picture will be written using the specified picture format.

Example:

            QPictureIO iio = new QPictureIO();
            QPicture   picture = new QPicture();
            QPainter painter = new QPainter(picture);
            painter.drawPixmap(0, 0, pixmap);
            iio.setPicture(picture);
            iio.setFileName("vegeburger.pic");
            iio.setFormat("PIC");
            if (iio.write())
                return;
    

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


inputFormats

public static java.util.List inputFormats()
Returns a sorted list of picture formats that are supported for picture input.


outputFormats

public static java.util.List outputFormats()
Returns a sorted list of picture formats that are supported for picture output.


pictureFormat

public static QByteArray pictureFormat(QIODevice arg__1)
This is an overloaded member function, provided for convenience.

Returns a string that specifies the picture format of the picture 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:
QIODevice::at().


pictureFormat

public static QByteArray pictureFormat(java.lang.String fileName)
Returns a string that specifies the picture format of the file fileName, or null if the file cannot be read or if the format is not recognized.


format

public final java.lang.String format()
Returns the picture format string or null if no format has been explicitly set.


parameters

public final java.lang.String parameters()
Returns the picture's parameters string.


setFormat

public final void setFormat(java.lang.String format)
Sets the picture format to format for the picture to be read or written.

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

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


setParameters

public final void setParameters(java.lang.String parameters)
Sets the picture's parameter string to parameters. This is for picture handlers that require special parameters.

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