diff options
Diffstat (limited to 'doc/man/man3/qbitmap.3qt')
| -rw-r--r-- | doc/man/man3/qbitmap.3qt | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/doc/man/man3/qbitmap.3qt b/doc/man/man3/qbitmap.3qt new file mode 100644 index 000000000..1fba78713 --- /dev/null +++ b/doc/man/man3/qbitmap.3qt @@ -0,0 +1,159 @@ +'\" t +.TH QBitmap 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the +.\" license file included in the distribution for a complete license +.\" statement. +.\" +.ad l +.nh +.SH NAME +QBitmap \- Monochrome (1-bit depth) pixmaps +.SH SYNOPSIS +\fC#include <qbitmap.h>\fR +.PP +Inherits QPixmap. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQBitmap\fR ()" +.br +.ti -1c +.BI "\fBQBitmap\fR ( int w, int h, bool clear = FALSE, QPixmap::Optimization optimization = QPixmap::DefaultOptim )" +.br +.ti -1c +.BI "\fBQBitmap\fR ( const QSize & size, bool clear = FALSE, QPixmap::Optimization optimization = QPixmap::DefaultOptim )" +.br +.ti -1c +.BI "\fBQBitmap\fR ( int w, int h, const uchar * bits, bool isXbitmap = FALSE )" +.br +.ti -1c +.BI "\fBQBitmap\fR ( const QSize & size, const uchar * bits, bool isXbitmap = FALSE )" +.br +.ti -1c +.BI "\fBQBitmap\fR ( const QBitmap & bitmap )" +.br +.ti -1c +.BI "\fBQBitmap\fR ( const QString & fileName, const char * format = 0 )" +.br +.ti -1c +.BI "QBitmap & \fBoperator=\fR ( const QBitmap & bitmap )" +.br +.ti -1c +.BI "QBitmap & \fBoperator=\fR ( const QPixmap & pixmap )" +.br +.ti -1c +.BI "QBitmap & \fBoperator=\fR ( const QImage & image )" +.br +.ti -1c +.BI "QBitmap \fBxForm\fR ( const QWMatrix & matrix ) const" +.br +.in -1c +.SH DESCRIPTION +The QBitmap class provides monochrome (1-bit depth) pixmaps. +.PP +The QBitmap class is a monochrome off-screen paint device used mainly for creating custom QCursor and QBrush objects, in QPixmap::setMask() and for QRegion. +.PP +A QBitmap is a QPixmap 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 QBitmap is guaranteed to always have the depth 1, unless it is QPixmap::isNull() which has depth 0. +.PP +When drawing in a QBitmap (or QPixmap with depth 1), we recommend using the QColor objects \fCQt::color0\fR and \fCQt::color1\fR. Painting with \fCcolor0\fR sets the bitmap bits to 0, and painting with \fCcolor1\fR sets the bits to 1. For a bitmap, 0-bits indicate background (or transparent) and 1-bits indicate foreground (or opaque). Using the \fCblack\fR and \fCwhite\fR QColor objects make no sense because the QColor::pixel() value is not necessarily 0 for black and 1 for white. +.PP +The QBitmap can be transformed (translated, scaled, sheared or rotated) using xForm(). +.PP +Just like the QPixmap class, QBitmap is optimized by the use of implicit sharing, so it is very efficient to pass QBitmap objects as arguments. +.PP +See also QPixmap, QPainter::drawPixmap(), bitBlt(), Shared Classes, Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QBitmap::QBitmap ()" +Constructs a null bitmap. +.PP +See also QPixmap::isNull(). +.SH "QBitmap::QBitmap ( int w, int h, bool clear = FALSE, QPixmap::Optimization optimization = QPixmap::DefaultOptim )" +Constructs a bitmap with width \fIw\fR and height \fIh\fR. +.PP +The contents of the bitmap is uninitialized if \fIclear\fR is FALSE; otherwise it is filled with pixel value 0 (the QColor \fCQt::color0\fR). +.PP +The optional \fIoptimization\fR 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 QPixmap::Optimization. +.PP +See also QPixmap::setOptimization() and QPixmap::setDefaultOptimization(). +.SH "QBitmap::QBitmap ( const QSize & size, bool clear = FALSE, QPixmap::Optimization optimization = QPixmap::DefaultOptim )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a bitmap with the size \fIsize\fR. +.PP +The contents of the bitmap is uninitialized if \fIclear\fR is FALSE; otherwise it is filled with pixel value 0 (the QColor \fCQt::color0\fR). +.PP +The optional \fIoptimization\fR 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 QPixmap::Optimization. +.SH "QBitmap::QBitmap ( int w, int h, const uchar * bits, bool isXbitmap = FALSE )" +Constructs a bitmap with width \fIw\fR and height \fIh\fR and sets the contents to \fIbits\fR. +.PP +The \fIisXbitmap\fR flag should be TRUE if \fIbits\fR was generated by the X11 bitmap program. The X bitmap bit order is little endian. The QImage documentation discusses bit order of monochrome images. +.PP +Example (creates an arrow bitmap): +.PP +.nf +.br + uchar arrow_bits[] = { 0x3f, 0x1f, 0x0f, 0x1f, 0x3b, 0x71, 0xe0, 0xc0 }; +.br + QBitmap bm( 8, 8, arrow_bits, TRUE ); +.br +.fi +.SH "QBitmap::QBitmap ( const QSize & size, const uchar * bits, bool isXbitmap = FALSE )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Constructs a bitmap with the size \fIsize\fR and sets the contents to \fIbits\fR. +.PP +The \fIisXbitmap\fR flag should be TRUE if \fIbits\fR was generated by the X11 bitmap program. The X bitmap bit order is little endian. The QImage documentation discusses bit order of monochrome images. +.SH "QBitmap::QBitmap ( const QBitmap & bitmap )" +Constructs a bitmap that is a copy of \fIbitmap\fR. +.SH "QBitmap::QBitmap ( const QString & fileName, const char * format = 0 )" +Constructs a bitmap from the file \fIfileName\fR. If the file does not exist or is of an unknown format, the bitmap becomes a null bitmap. +.PP +The parameters \fIfileName\fR and \fIformat\fR are passed on to QPixmap::load(). Dithering will be performed if the file format uses more than 1 bit per pixel. +.PP +See also QPixmap::isNull(), QPixmap::load(), QPixmap::loadFromData(), QPixmap::save(), and QPixmap::imageFormat(). +.SH "QBitmap & QBitmap::operator= ( const QBitmap & bitmap )" +Assigns the bitmap \fIbitmap\fR to this bitmap and returns a reference to this bitmap. +.SH "QBitmap & QBitmap::operator= ( const QPixmap & pixmap )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Assigns the pixmap \fIpixmap\fR to this bitmap and returns a reference to this bitmap. +.PP +Dithering will be performed if the pixmap has a QPixmap::depth() greater than 1. +.SH "QBitmap & QBitmap::operator= ( const QImage & image )" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Converts the image \fIimage\fR to a bitmap and assigns the result to this bitmap. Returns a reference to the bitmap. +.PP +Dithering will be performed if the image has a QImage::depth() greater than 1. +.SH "QBitmap QBitmap::xForm ( const QWMatrix & matrix ) const" +Returns a transformed copy of this bitmap by using \fImatrix\fR. +.PP +This function does exactly the same as QPixmap::xForm(), except that it returns a QBitmap instead of a QPixmap. +.PP +See also QPixmap::xForm(). + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qbitmap.html +.BR http://www.trolltech.com/faq/tech.html +.SH COPYRIGHT +Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the +license file included in the distribution for a complete license +statement. +.SH AUTHOR +Generated automatically from the source code. +.SH BUGS +If you find a bug in Qt, please report it as described in +.BR http://doc.trolltech.com/bughowto.html . +Good bug reports help us to help you. Thank you. +.P +The definitive Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt Assistant or with +a web browser. This man page is provided as a convenience for those +users who prefer man pages, although this format is not officially +supported by Trolltech. +.P +If you find errors in this manual page, please report them to +.BR [email protected] . +Please include the name of the manual page (qbitmap.3qt) and the Qt +version (3.3.8). |