From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqbitmap.html | 186 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 doc/html/ntqbitmap.html (limited to 'doc/html/ntqbitmap.html') diff --git a/doc/html/ntqbitmap.html b/doc/html/ntqbitmap.html new file mode 100644 index 000000000..f0e55c2de --- /dev/null +++ b/doc/html/ntqbitmap.html @@ -0,0 +1,186 @@ + + + + + +TQBitmap Class + + + + + + + +

TQBitmap Class Reference

+ +

The TQBitmap class provides monochrome (1-bit depth) pixmaps. +More... +

#include <ntqbitmap.h> +

Inherits TQPixmap. +

List of all member functions. +

Public Members

TQBitmap ()
TQBitmap ( int w, int h, bool clear = FALSE, TQPixmap::Optimization optimization = TQPixmap::DefaultOptim )
TQBitmap ( const TQSize & size, bool clear = FALSE, TQPixmap::Optimization optimization = TQPixmap::DefaultOptim )
TQBitmap ( int w, int h, const uchar * bits, bool isXbitmap = FALSE )
TQBitmap ( const TQSize & size, const uchar * bits, bool isXbitmap = FALSE )
TQBitmap ( const TQBitmap & bitmap )
TQBitmap ( const TQString & fileName, const char * format = 0 )
TQBitmap & operator= ( const TQBitmap & bitmap )
TQBitmap & operator= ( const TQPixmap & pixmap )
TQBitmap & operator= ( const TQImage & image )
TQBitmap xForm ( const TQWMatrix & matrix ) const

Detailed Description

+ + +The TQBitmap class provides monochrome (1-bit depth) pixmaps. +

+ + +

The TQBitmap class is a monochrome off-screen paint device used +mainly for creating custom TQCursor and TQBrush objects, in +TQPixmap::setMask() and for TQRegion. +

A TQBitmap is a TQPixmap with a depth +of 1. If a pixmap with a depth greater than 1 is assigned to a +bitmap, the bitmap will be dithered automatically. A TQBitmap is +guaranteed to always have the depth 1, unless it is +TQPixmap::isNull() which has depth 0. +

When drawing in a TQBitmap (or TQPixmap with depth 1), we recommend +using the TQColor objects TQt::color0 and TQt::color1. +Painting with color0 sets the bitmap bits to 0, and painting +with color1 sets the bits to 1. For a bitmap, 0-bits indicate +background (or transparent) and 1-bits indicate foreground (or +opaque). Using the black and white TQColor objects make no +sense because the TQColor::pixel() value is not necessarily 0 for +black and 1 for white. +

The TQBitmap can be transformed (translated, scaled, sheared or +rotated) using xForm(). +

Just like the TQPixmap class, TQBitmap is optimized by the use of +implicit sharing, so it is very +efficient to pass TQBitmap objects as arguments. +

Member Function Documentation

TQBitmap::TQBitmap () +

+Constructs a null bitmap. +

TQBitmap::TQBitmap ( int w, int h, bool clear = FALSE, TQPixmap::Optimization optimization = TQPixmap::DefaultOptim ) +

+Constructs a bitmap with width w and height h. +

The contents of the bitmap is uninitialized if clear is FALSE; +otherwise it is filled with pixel value 0 (the TQColor TQt::color0). +

The optional optimization argument specifies the optimization +setting for the bitmap. The default optimization should be used in +most cases. Games and other pixmap-intensive applications may +benefit from setting this argument; see TQPixmap::Optimization. +

TQBitmap::TQBitmap ( const TQSize & size, bool clear = FALSE, TQPixmap::Optimization optimization = TQPixmap::DefaultOptim ) +

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

Constructs a bitmap with the size size. +

The contents of the bitmap is uninitialized if clear is FALSE; +otherwise it is filled with pixel value 0 (the TQColor TQt::color0). +

TQBitmap::TQBitmap ( int w, int h, const uchar * bits, bool isXbitmap = FALSE ) +

+Constructs a bitmap with width w and height h and sets the +contents to bits. +

The isXbitmap flag should be TRUE if bits was generated by +the X11 bitmap program. The X bitmap bit order is little endian. +The TQImage documentation discusses bit order of monochrome images. +

Example (creates an arrow bitmap): +

+        uchar arrow_bits[] = { 0x3f, 0x1f, 0x0f, 0x1f, 0x3b, 0x71, 0xe0, 0xc0 };
+        TQBitmap bm( 8, 8, arrow_bits, TRUE );
+

+ + +

TQBitmap::TQBitmap ( const TQSize & size, const uchar * bits, bool isXbitmap = FALSE ) +

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

Constructs a bitmap with the size size and sets the contents to +bits. +

The isXbitmap flag should be TRUE if bits was generated by +the X11 bitmap program. The X bitmap bit order is little endian. +The TQImage documentation discusses bit order of monochrome images. + +

TQBitmap::TQBitmap ( const TQBitmap & bitmap ) +

+Constructs a bitmap that is a copy of bitmap. + +

TQBitmap::TQBitmap ( const TQString & fileName, const char * format = 0 ) +

+Constructs a bitmap from the file fileName. If the file does +not exist or is of an unknown format, the bitmap becomes a null +bitmap. +

The parameters fileName and format are passed on to +TQPixmap::load(). Dithering will be performed if the file format +uses more than 1 bit per pixel. +

TQBitmap & TQBitmap::operator= ( const TQBitmap & bitmap ) +

+Assigns the bitmap bitmap to this bitmap and returns a +reference to this bitmap. + +

TQBitmap & TQBitmap::operator= ( const TQPixmap & pixmap ) +

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

Assigns the pixmap pixmap to this bitmap and returns a +reference to this bitmap. +

Dithering will be performed if the pixmap has a TQPixmap::depth() +greater than 1. + +

TQBitmap & TQBitmap::operator= ( const TQImage & image ) +

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

Converts the image image to a bitmap and assigns the result to +this bitmap. Returns a reference to the bitmap. +

Dithering will be performed if the image has a TQImage::depth() +greater than 1. + +

TQBitmap TQBitmap::xForm ( const TQWMatrix & matrix ) const +

+Returns a transformed copy of this bitmap by using matrix. +

This function does exactly the same as TQPixmap::xForm(), except +that it returns a TQBitmap instead of a TQPixmap. +