diff options
Diffstat (limited to 'doc/man/man3/tqimage.3qt')
| -rw-r--r-- | doc/man/man3/tqimage.3qt | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/man/man3/tqimage.3qt b/doc/man/man3/tqimage.3qt index 2db8e6b9c..448e20cf3 100644 --- a/doc/man/man3/tqimage.3qt +++ b/doc/man/man3/tqimage.3qt @@ -146,7 +146,7 @@ TQImage \- Hardware-independent pixmap representation with direct access to the .BI "void \fBfill\fR ( uint pixel )" .br .ti -1c -.BI "void \fBinvertPixels\fR ( bool invertAlpha = TRUE )" +.BI "void \fBinvertPixels\fR ( bool invertAlpha = true )" .br .ti -1c .BI "TQImage \fBconvertDepth\fR ( int depth ) const" @@ -188,7 +188,7 @@ TQImage \- Hardware-independent pixmap representation with direct access to the .BI "TQImage \fBcreateAlphaMask\fR ( int conversion_flags = 0 ) const" .br .ti -1c -.BI "TQImage \fBcreateHeuristicMask\fR ( bool clipTight = TRUE ) const" +.BI "TQImage \fBcreateHeuristicMask\fR ( bool clipTight = true ) const" .br .ti -1c .BI "TQImage \fBmirror\fR () const" @@ -467,7 +467,7 @@ Constructs a shallow copy of \fIimage\fR. .SH "TQImage::~TQImage ()" Destroys the image and cleans up. .SH "bool TQImage::allGray () const" -Returns TRUE if all the colors in the image are shades of gray (i.e. their red, green and blue components are equal); otherwise returns FALSE. +Returns true if all the colors in the image are shades of gray (i.e. their red, green and blue components are equal); otherwise returns false. .PP This function is slow for 32-bit images. .PP @@ -551,7 +551,7 @@ Returns a deep copy of a sub-area of the image. .PP The returned image always has the size of the rectangle \fIr\fR. In areas beyond this image pixels are filled with pixel 0. .SH "bool TQImage::create ( int width, int height, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )" -Sets the image \fIwidth\fR, \fIheight\fR, \fIdepth\fR, its number of colors (in \fInumColors\fR), and bit order. Returns TRUE if successful, or FALSE if the parameters are incorrect or if memory cannot be allocated. +Sets the image \fIwidth\fR, \fIheight\fR, \fIdepth\fR, its number of colors (in \fInumColors\fR), and bit order. Returns true if successful, or false if the parameters are incorrect or if memory cannot be allocated. .PP The \fIwidth\fR and \fIheight\fR is limited to 32767. \fIdepth\fR must be 1, 8, or 32. If \fIdepth\fR is 1, \fIbitOrder\fR must be set to either TQImage::LittleEndian or TQImage::BigEndian. For other depths \fIbitOrder\fR must be TQImage::IgnoreEndian. .PP @@ -570,14 +570,14 @@ See TQPixmap::convertFromImage() for a description of the \fIconversion_flags\fR The returned image has little-endian bit order, which you can convert to big-endianness using convertBitOrder(). .PP See also createHeuristicMask(), hasAlphaBuffer(), and setAlphaBuffer(). -.SH "TQImage TQImage::createHeuristicMask ( bool clipTight = TRUE ) const" +.SH "TQImage TQImage::createHeuristicMask ( bool clipTight = true ) const" Creates and returns a 1-bpp heuristic mask for this image. It works by selecting a color from one of the corners, then chipping away pixels of that color starting at all the edges. .PP The four corners vote for which color is to be masked away. In case of a draw (this generally means that this function is not applicable to the image), the result is arbitrary. .PP The returned image has little-endian bit order, which you can convert to big-endianness using convertBitOrder(). .PP -If \fIclipTight\fR is TRUE the mask is just large enough to cover the pixels; otherwise, the mask is larger than the data pixels. +If \fIclipTight\fR is true the mask is just large enough to cover the pixels; otherwise, the mask is larger than the data pixels. .PP This function disregards the alpha buffer. .PP @@ -621,7 +621,7 @@ Convenience function. Gets the data associated with the absolute name \fIabs_nam .PP See also TQMimeSourceFactory, TQImage::fromMimeSource(), and TQImageDrag::decode(). .SH "bool TQImage::hasAlphaBuffer () const" -Returns TRUE if alpha buffer mode is enabled; otherwise returns FALSE. +Returns true if alpha buffer mode is enabled; otherwise returns false. .PP See also setAlphaBuffer(). .SH "int TQImage::height () const" @@ -665,10 +665,10 @@ Example: showimg/showimg.cpp. Returns a list of image formats that are supported for image input. .PP See also outputFormats(), inputFormatList(), and TQImageIO. -.SH "void TQImage::invertPixels ( bool invertAlpha = TRUE )" +.SH "void TQImage::invertPixels ( bool invertAlpha = true )" Inverts all pixel values in the image. .PP -If the depth is 32: if \fIinvertAlpha\fR is TRUE, the alpha bits are also inverted, otherwise they are left unchanged. +If the depth is 32: if \fIinvertAlpha\fR is true, the alpha bits are also inverted, otherwise they are left unchanged. .PP If the depth is not 32, the argument \fIinvertAlpha\fR has no meaning. .PP @@ -678,11 +678,11 @@ See also fill(), depth(), and hasAlphaBuffer(). .SH "bool TQImage::isGrayscale () const" For 32-bit images, this function is equivalent to allGray(). .PP -For 8-bpp images, this function returns TRUE if color(i) is TQRgb(i,i,i) for all indices of the color table; otherwise returns FALSE. +For 8-bpp images, this function returns true if color(i) is TQRgb(i,i,i) for all indices of the color table; otherwise returns false. .PP See also allGray() and depth(). .SH "bool TQImage::isNull () const" -Returns TRUE if it is a null image; otherwise returns FALSE. +Returns true if it is a null image; otherwise returns false. .PP A null image has all parameters set to zero and no allocated data. .PP @@ -694,7 +694,7 @@ This is the beginning of the data block for the image. .PP See also bits() and scanLine(). .SH "bool TQImage::load ( const TQString & fileName, const char * format = 0 )" -Loads an image from the file \fIfileName\fR. Returns TRUE if the image was successfully loaded; otherwise returns FALSE. +Loads an image from the file \fIfileName\fR. Returns true if the image was successfully loaded; otherwise returns false. .PP If \fIformat\fR is specified, the loader attempts to read the image using the specified format. If \fIformat\fR is not specified (which is the default), the loader reads a few bytes from the header to guess the file format. .PP @@ -702,7 +702,7 @@ The TQImageIO documentation lists the supported image formats and explains how t .PP See also loadFromData(), save(), imageFormat(), TQPixmap::load(), and TQImageIO. .SH "bool TQImage::loadFromData ( const uchar * buf, uint len, const char * format = 0 )" -Loads an image from the first \fIlen\fR bytes of binary data in \fIbuf\fR. Returns TRUE if the image was successfully loaded; otherwise returns FALSE. +Loads an image from the first \fIlen\fR bytes of binary data in \fIbuf\fR. Returns true if the image was successfully loaded; otherwise returns false. .PP If \fIformat\fR is specified, the loader attempts to read the image using the specified format. If \fIformat\fR is not specified (which is the default), the loader reads a few bytes from the header to guess the file format. .PP @@ -718,7 +718,7 @@ Returns a TQImage which is a vertically mirrored copy of this image. The origina .SH "TQImage TQImage::mirror ( bool horizontal, bool vertical ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns a mirror of the image, mirrored in the horizontal and/or the vertical direction depending on whether \fIhorizontal\fR and \fIvertical\fR are set to TRUE or FALSE. The original image is not changed. +Returns a mirror of the image, mirrored in the horizontal and/or the vertical direction depending on whether \fIhorizontal\fR and \fIvertical\fR are set to true or false. The original image is not changed. .PP See also smoothScale(). .SH "int TQImage::numBytes () const" @@ -736,7 +736,7 @@ Example: themes/wood.cpp. .SH "TQPoint TQImage::offset () const" Returns the number of pixels by which the image is intended to be offset by when positioning relative to other images. .SH "bool TQImage::operator!= ( const TQImage & i ) const" -Returns TRUE if this image and image \fIi\fR have different contents; otherwise returns FALSE. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. +Returns true if this image and image \fIi\fR have different contents; otherwise returns false. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. .PP See also operator=(). .SH "TQImage & TQImage::operator= ( const TQImage & image )" @@ -752,7 +752,7 @@ If the image shares data with other images, it will first dereference the shared .PP Makes a call to TQPixmap::convertToImage(). .SH "bool TQImage::operator== ( const TQImage & i ) const" -Returns TRUE if this image and image \fIi\fR have the same contents; otherwise returns FALSE. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. +Returns true if this image and image \fIi\fR have the same contents; otherwise returns false. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. .PP See also operator=(). .SH "TQStringList TQImage::outputFormatList ()\fC [static]\fR" @@ -807,7 +807,7 @@ Resets all image parameters and deallocates the image data. .SH "bool TQImage::save ( const TQString & fileName, const char * format, int quality = -1 ) const" Saves the image to the file \fIfileName\fR, using the image file format \fIformat\fR and a quality factor of \fIquality\fR. \fIquality\fR must be in the range 0..100 or -1. Specify 0 to obtain small compressed files, 100 for large uncompressed files, and -1 (the default) to use the default settings. .PP -Returns TRUE if the image was successfully saved; otherwise returns FALSE. +Returns true if the image was successfully saved; otherwise returns false. .PP See also load(), loadFromData(), imageFormat(), TQPixmap::save(), and TQImageIO. .SH "bool TQImage::save ( TQIODevice * device, const char * format, int quality = -1 ) const" @@ -871,7 +871,7 @@ See also bytesPerLine(), bits(), and jumpTable(). .PP Example: desktop/desktop.cpp. .SH "void TQImage::setAlphaBuffer ( bool enable )" -Enables alpha buffer mode if \fIenable\fR is TRUE, otherwise disables it. The default setting is disabled. +Enables alpha buffer mode if \fIenable\fR is true, otherwise disables it. The default setting is disabled. .PP An 8-bpp image has 8-bit pixels. A pixel is an index into the color table, which contains 32-bit color values. In a 32-bpp image, the 32-bit pixels are the color values. .PP @@ -1016,7 +1016,7 @@ Note that if you want to iterate over the list, you should iterate over a copy, .br .fi .SH "bool TQImage::valid ( int x, int y ) const" -Returns TRUE if ( \fIx\fR, \fIy\fR ) is a valid coordinate in the image; otherwise returns FALSE. +Returns true if ( \fIx\fR, \fIy\fR ) is a valid coordinate in the image; otherwise returns false. .PP See also width(), height(), and pixelIndex(). .PP |